Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update inputs #187

Merged
merged 3 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ type Spec = ArraySpec | BooleanSpec | NumberSpec | ObjectSpec | StringSpec;
| viewSpec.oneOfParams | `object` | | [Parameters](#oneofparams) that must be passed to oneof input |
| viewSpec.placeholder | `string` | | A short hint displayed in the field before the user enters the value |
| viewSpec.hidden | `boolean` | | Hide field and view |
| viewSpec.delimiter | `Record<string, string>` | | Values of delimiters of inline object input elements |

### StringSpec

Expand Down Expand Up @@ -144,9 +145,10 @@ type Spec = ArraySpec | BooleanSpec | NumberSpec | ObjectSpec | StringSpec;

#### OneOfParams

| Property | Type | Required | Description |
| :------- | :---------------------------- | :------: | :---------- |
| toggler | `'select'` `'radio'` `'card'` | | Switch type |
| Property | Type | Required | Description |
| :--------- | :----------------------------------------- | :------: | :--------------------------------------------- |
| toggler | `'select'` `'radio'` `'card'` `'checkbox'` | | Switch type |
| booleanMap | `Record<'true' 'false', string>` | | Special object for oneof toggler type checkbox |

#### FileInput

Expand Down
4 changes: 3 additions & 1 deletion src/lib/core/types/specs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,14 @@ export interface ObjectSpec<
order?: string[];
link?: LinkType;
oneOfParams?: {
toggler?: 'select' | 'radio' | 'card';
toggler?: 'select' | 'radio' | 'card' | 'checkbox';
booleanMap?: Record<'true' | 'false', string>;
};
placeholder?: string;
hidden?: boolean;
inputProps?: InputComponentProps;
layoutProps?: LayoutComponentProps;
delimiter?: Record<string, string>;
};
}

Expand Down
7 changes: 7 additions & 0 deletions src/lib/kit/components/Inputs/ObjectBase/ObjectBase.scss
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,11 @@
}
}
}

&__delimiter {
display: flex;
margin-right: 8px;
align-items: center;
white-space: nowrap;
}
}
35 changes: 22 additions & 13 deletions src/lib/kit/components/Inputs/ObjectBase/ObjectBase.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import React from 'react';

import {Plus} from '@gravity-ui/icons';
import {Button, Icon} from '@gravity-ui/uikit';
import _ from 'lodash';
import {Button, Icon, Text} from '@gravity-ui/uikit';
import isObjectLike from 'lodash/isObjectLike';
import set from 'lodash/set';

import {
Controller,
Expand Down Expand Up @@ -53,7 +54,7 @@ export const ObjectBase: React.FC<ObjectBaseProps> = ({
(childName: string, childValue: FieldValue, childErrors?: Record<string, ValidateError>) =>
restProps.input.onChange(
(currentValue) =>
_.set(
set(
{...currentValue},
childName.split(`${restProps.input.name}.`).join(''),
childValue,
Expand All @@ -66,7 +67,7 @@ export const ObjectBase: React.FC<ObjectBaseProps> = ({
const content = React.useMemo(() => {
if (
!spec.properties ||
!_.isObjectLike(spec.properties) ||
!isObjectLike(spec.properties) ||
!Object.keys(spec.properties || {}).length
) {
return null;
Expand All @@ -80,24 +81,32 @@ export const ObjectBase: React.FC<ObjectBaseProps> = ({
? filterPropertiesForObjectInline(spec.properties)
: spec.properties;

const delimiter = spec.viewSpec.delimiter;
const orderProperties = spec.viewSpec.order || Object.keys(specProperties);

return (
<div className={b('content', {inline})}>
{(spec.viewSpec.order || Object.keys(specProperties)).map((property: string) =>
{orderProperties.map((property: string) =>
specProperties[property] ? (
<Controller
value={restProps.input.value?.[property]}
spec={specProperties[property]}
name={`${name ? name + '.' : ''}${property}`}
parentOnChange={parentOnChange}
parentOnUnmount={restProps.input.parentOnUnmount}
key={`${name ? name + '.' : ''}${property}`}
/>
<React.Fragment key={`${name ? name + '.' : ''}${property}`}>
<Controller
value={restProps.input.value?.[property]}
spec={specProperties[property]}
name={`${name ? name + '.' : ''}${property}`}
parentOnChange={parentOnChange}
parentOnUnmount={restProps.input.parentOnUnmount}
/>
{delimiter && delimiter[property] ? (
<Text className={b('delimiter')}>{delimiter[property]}</Text>
) : null}
</React.Fragment>
) : null,
)}
</div>
);
}, [
spec.properties,
spec.viewSpec.delimiter,
spec.viewSpec.order,
restProps.input.value,
restProps.input.parentOnUnmount,
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React from 'react';

import {OBJECT_BASE, VALUE} from './helpers';
import {OBJECT_BASE, OBJECT_INLINE, VALUE, VALUE_INLINE} from './helpers';

import {test} from '~playwright/core';
import {DynamicForm} from '~playwright/core/DynamicForm';
Expand Down Expand Up @@ -75,8 +75,36 @@ test.describe('Object Base', () => {
});
});

test.describe('Object Inline', () => {
test('default', async ({mount, expectScreenshot}) => {
await mount(<DynamicForm spec={OBJECT_INLINE.default} />);

await expectScreenshot();
});

test('delimiter', async ({mount, expectScreenshot}) => {
await mount(<DynamicForm spec={OBJECT_INLINE.delimiter} />);

await expectScreenshot();
});
});

test('Object Base view', async ({mount, expectScreenshot}) => {
await mount(<DynamicView spec={OBJECT_BASE.default} value={VALUE} />);

await expectScreenshot();
});

test.describe('Object Inline view', () => {
test('default', async ({mount, expectScreenshot}) => {
await mount(<DynamicView spec={OBJECT_INLINE.default} value={VALUE_INLINE} />);

await expectScreenshot();
});

test('delimiter', async ({mount, expectScreenshot}) => {
await mount(<DynamicView spec={OBJECT_INLINE.delimiter} value={VALUE_INLINE} />);

await expectScreenshot();
});
});
66 changes: 66 additions & 0 deletions src/lib/kit/components/Inputs/ObjectBase/__tests__/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,73 @@ export const OBJECT_BASE: Record<string, ObjectSpec> = {
},
};

export const OBJECT_INLINE: Record<string, ObjectSpec> = {
default: {
type: SpecTypes.Object,
defaultValue: {type: 'first', name: 'Name'},
properties: {
type: {
type: SpecTypes.String,
enum: ['first', 'second', 'third'],
viewSpec: {
type: 'select',
placeholder: 'Choose type',
layout: 'transparent',
layoutTitle: 'Type',
},
},
name: {
type: SpecTypes.String,
viewSpec: {
type: 'base',
placeholder: 'Type your name',
layout: 'transparent',
layoutTitle: 'Name',
},
},
},
viewSpec: {
type: 'inline',
layout: 'row',
layoutTitle: 'Candidate',
},
},
delimiter: {
type: SpecTypes.Object,
defaultValue: {type: 'first', name: 'Name'},
properties: {
type: {
type: SpecTypes.String,
enum: ['first', 'second', 'third'],
viewSpec: {
type: 'select',
placeholder: 'Choose type',
layout: 'transparent',
layoutTitle: 'Type',
},
},
name: {
type: SpecTypes.String,
viewSpec: {
type: 'base',
placeholder: 'Type your name',
layout: 'transparent',
layoutTitle: 'Name',
},
},
},
viewSpec: {
type: 'inline',
layout: 'row',
layoutTitle: 'Candidate',
delimiter: {type: ':'},
},
},
};

export const VALUE: FormValue = {
name: 'name',
age: 10,
};

export const VALUE_INLINE: FormValue = {type: 'first', name: 'Name'};
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ import React from 'react';
import _ from 'lodash';

import {Controller, FieldValue, ObjectIndependentInput, ValidateError} from '../../../../core';

const OBJECT_VALUE_PROPERTY_NAME = 'value';
import {OBJECT_VALUE_PROPERTY_NAME} from '../../../constants/common';

export const ObjectValueInput: ObjectIndependentInput = (props) => {
const {spec, input, name, Layout} = props;
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ test.describe('OneOf', () => {
await expectScreenshot();
});
});

test('toggler checkbox default', async ({mount, expectScreenshot}) => {
await mount(<DynamicForm spec={ONEOF.defaultCheckbox} />);

await expectScreenshot();
});
});

test.describe('OneOf view', () => {
Expand Down Expand Up @@ -78,6 +84,12 @@ test.describe('OneOf view', () => {
await expectScreenshot();
});
});

test('toggler checkbox default', async ({mount, expectScreenshot}) => {
await mount(<DynamicView spec={ONEOF.defaultCheckbox} value={VALUE.object} />);

await expectScreenshot();
});
});

test.describe('OneOf Flat', () => {
Expand Down Expand Up @@ -112,6 +124,12 @@ test.describe('OneOf Flat', () => {
await expectScreenshot();
});
});

test('toggler checkbox default', async ({mount, expectScreenshot}) => {
await mount(<DynamicForm spec={ONEOF_FALT.defaultCheckbox} />);

await expectScreenshot();
});
});

test.describe('OneOf Flat view', () => {
Expand Down Expand Up @@ -140,4 +158,10 @@ test.describe('OneOf Flat view', () => {
await expectScreenshot();
});
});

test('toggler checkbox default', async ({mount, expectScreenshot}) => {
await mount(<DynamicView spec={ONEOF_FALT.defaultCheckbox} value={VALUE.string} />);

await expectScreenshot();
});
});
Loading
Loading