From 2b70c89962a18f33995fcca762fed73fd5ce8f28 Mon Sep 17 00:00:00 2001 From: Armand Philippot Date: Fri, 1 Apr 2022 22:46:07 +0200 Subject: chore: add labelled field component --- .../molecules/forms/labelled-field.stories.tsx | 180 +++++++++++++++++++++ .../molecules/forms/labelled-field.test.tsx | 19 +++ src/components/molecules/forms/labelled-field.tsx | 25 +++ 3 files changed, 224 insertions(+) create mode 100644 src/components/molecules/forms/labelled-field.stories.tsx create mode 100644 src/components/molecules/forms/labelled-field.test.tsx create mode 100644 src/components/molecules/forms/labelled-field.tsx (limited to 'src/components/molecules/forms') diff --git a/src/components/molecules/forms/labelled-field.stories.tsx b/src/components/molecules/forms/labelled-field.stories.tsx new file mode 100644 index 0000000..eb7f8b5 --- /dev/null +++ b/src/components/molecules/forms/labelled-field.stories.tsx @@ -0,0 +1,180 @@ +import { ComponentMeta, ComponentStory } from '@storybook/react'; +import LabelledFieldComponent from './labelled-field'; + +export default { + title: 'Molecules/Forms', + component: LabelledFieldComponent, + args: { + disabled: false, + required: false, + }, + argTypes: { + disabled: { + control: { + type: 'boolean', + }, + description: 'Field state: either enabled or disabled.', + table: { + category: 'Options', + defaultValue: { summary: false }, + }, + type: { + name: 'boolean', + required: false, + }, + }, + id: { + control: { + type: 'text', + }, + description: 'Field id.', + type: { + name: 'string', + required: true, + }, + }, + label: { + control: { + type: 'text', + }, + description: 'Field label.', + type: { + name: 'string', + required: true, + }, + }, + max: { + control: { + type: 'number', + }, + description: 'Maximum value.', + table: { + category: 'Options', + }, + type: { + name: 'number', + required: false, + }, + }, + min: { + control: { + type: 'number', + }, + description: 'Minimum value.', + table: { + category: 'Options', + }, + type: { + name: 'number', + required: false, + }, + }, + name: { + control: { + type: 'text', + }, + description: 'Field name.', + type: { + name: 'string', + required: true, + }, + }, + placeholder: { + control: { + type: 'text', + }, + description: 'A placeholder value.', + table: { + category: 'Options', + }, + type: { + name: 'string', + required: false, + }, + }, + required: { + control: { + type: 'boolean', + }, + description: 'Determine if the field is required.', + table: { + category: 'Options', + defaultValue: { summary: false }, + }, + type: { + name: 'boolean', + required: false, + }, + }, + setValue: { + control: { + type: null, + }, + description: 'Callback function to set field value.', + table: { + category: 'Events', + }, + type: { + name: 'function', + required: true, + }, + }, + step: { + control: { + type: 'number', + }, + description: 'Field incremental values that are valid.', + table: { + category: 'Options', + }, + type: { + name: 'number', + required: false, + }, + }, + type: { + control: { + type: 'select', + }, + description: 'Field type: input type or textarea.', + options: [ + 'datetime-local', + 'email', + 'number', + 'search', + 'tel', + 'text', + 'textarea', + 'time', + 'url', + ], + type: { + name: 'string', + required: true, + }, + }, + value: { + control: { + type: 'text', + }, + description: 'Field value.', + type: { + name: 'string', + required: true, + }, + }, + }, +} as ComponentMeta; + +const Template: ComponentStory = (args) => ( + +); + +export const LabelledField = Template.bind({}); +LabelledField.args = { + id: 'labelled-field-storybook', + label: 'Labelled field', + name: 'labelled-field-storybook', + setValue: () => null, + value: '', +}; diff --git a/src/components/molecules/forms/labelled-field.test.tsx b/src/components/molecules/forms/labelled-field.test.tsx new file mode 100644 index 0000000..6fabe19 --- /dev/null +++ b/src/components/molecules/forms/labelled-field.test.tsx @@ -0,0 +1,19 @@ +import { render, screen } from '@test-utils'; +import LabelledField from './labelled-field'; + +describe('LabelledField', () => { + it('renders a labelled field', () => { + render( + null} + /> + ); + expect(screen.getByLabelText('Jest text field')).toBeInTheDocument(); + expect(screen.getByRole('textbox')).toHaveValue('test'); + }); +}); diff --git a/src/components/molecules/forms/labelled-field.tsx b/src/components/molecules/forms/labelled-field.tsx new file mode 100644 index 0000000..7f81e23 --- /dev/null +++ b/src/components/molecules/forms/labelled-field.tsx @@ -0,0 +1,25 @@ +import Field, { type FieldProps } from '@components/atoms/forms/field'; +import Label from '@components/atoms/forms/label'; +import { FC } from 'react'; + +type LabelledFieldProps = FieldProps & { + label: string; +}; + +const LabelledField: FC = ({ + id, + label, + required, + ...props +}) => { + return ( + <> + + + + ); +}; + +export default LabelledField; -- cgit v1.2.3 From 21eb67ef5e59d36b996392f60b5045f152a64604 Mon Sep 17 00:00:00 2001 From: Armand Philippot Date: Fri, 1 Apr 2022 22:57:12 +0200 Subject: chore: add a labelled select field component --- src/components/atoms/forms/select.stories.tsx | 10 +- src/components/atoms/forms/select.tsx | 6 +- .../molecules/forms/labelled-select.stories.tsx | 127 +++++++++++++++++++++ .../molecules/forms/labelled-select.test.tsx | 25 ++++ src/components/molecules/forms/labelled-select.tsx | 25 ++++ 5 files changed, 182 insertions(+), 11 deletions(-) create mode 100644 src/components/molecules/forms/labelled-select.stories.tsx create mode 100644 src/components/molecules/forms/labelled-select.test.tsx create mode 100644 src/components/molecules/forms/labelled-select.tsx (limited to 'src/components/molecules/forms') diff --git a/src/components/atoms/forms/select.stories.tsx b/src/components/atoms/forms/select.stories.tsx index 683e3b5..ed487f8 100644 --- a/src/components/atoms/forms/select.stories.tsx +++ b/src/components/atoms/forms/select.stories.tsx @@ -30,12 +30,9 @@ export default { type: 'text', }, description: 'Field id.', - table: { - category: 'Options', - }, type: { name: 'string', - required: false, + required: true, }, }, name: { @@ -43,12 +40,9 @@ export default { type: 'text', }, description: 'Field name.', - table: { - category: 'Options', - }, type: { name: 'string', - required: false, + required: true, }, }, options: { diff --git a/src/components/atoms/forms/select.tsx b/src/components/atoms/forms/select.tsx index 6e46660..e434a82 100644 --- a/src/components/atoms/forms/select.tsx +++ b/src/components/atoms/forms/select.tsx @@ -7,7 +7,7 @@ type SelectOptions = { value: string; }; -type SelectProps = { +export type SelectProps = { /** * Field state. Either enabled (false) or disabled (true). */ @@ -15,11 +15,11 @@ type SelectProps = { /** * Field id attribute. */ - id?: string; + id: string; /** * Field name attribute. */ - name?: string; + name: string; /** * True if the field is required. Default: false. */ diff --git a/src/components/molecules/forms/labelled-select.stories.tsx b/src/components/molecules/forms/labelled-select.stories.tsx new file mode 100644 index 0000000..0966e13 --- /dev/null +++ b/src/components/molecules/forms/labelled-select.stories.tsx @@ -0,0 +1,127 @@ +import { ComponentMeta, ComponentStory } from '@storybook/react'; +import LabelledSelectComponent from './labelled-select'; + +const selectOptions = [ + { id: 'option1', name: 'Option 1', value: 'option1' }, + { id: 'option2', name: 'Option 2', value: 'option2' }, + { id: 'option3', name: 'Option 3', value: 'option3' }, +]; + +export default { + title: 'Molecules/Forms', + component: LabelledSelectComponent, + args: { + disabled: false, + required: false, + }, + argTypes: { + disabled: { + control: { + type: 'boolean', + }, + description: 'Field state: either enabled or disabled.', + table: { + category: 'Options', + defaultValue: { summary: false }, + }, + type: { + name: 'boolean', + required: false, + }, + }, + id: { + control: { + type: 'text', + }, + description: 'Field id.', + type: { + name: 'string', + required: true, + }, + }, + label: { + control: { + type: 'text', + }, + description: 'Field label.', + type: { + name: 'string', + required: true, + }, + }, + name: { + control: { + type: 'text', + }, + description: 'Field name.', + type: { + name: 'string', + required: true, + }, + }, + options: { + control: { + type: null, + }, + description: 'Select options.', + type: { + name: 'array', + required: true, + value: { + name: 'string', + }, + }, + }, + required: { + control: { + type: 'boolean', + }, + description: 'Determine if the field is required.', + table: { + category: 'Options', + defaultValue: { summary: false }, + }, + type: { + name: 'boolean', + required: false, + }, + }, + setValue: { + control: { + type: null, + }, + description: 'Callback function to set field value.', + table: { + category: 'Events', + }, + type: { + name: 'function', + required: true, + }, + }, + value: { + control: { + type: 'text', + }, + description: 'Field value.', + type: { + name: 'string', + required: true, + }, + }, + }, +} as ComponentMeta; + +const Template: ComponentStory = (args) => ( + +); + +export const LabelledSelect = Template.bind({}); +LabelledSelect.args = { + id: 'labelled-select-storybook', + label: 'Labelled select', + name: 'labelled-select-storybook', + options: selectOptions, + setValue: () => null, + value: '', +}; diff --git a/src/components/molecules/forms/labelled-select.test.tsx b/src/components/molecules/forms/labelled-select.test.tsx new file mode 100644 index 0000000..9a50d6e --- /dev/null +++ b/src/components/molecules/forms/labelled-select.test.tsx @@ -0,0 +1,25 @@ +import { render, screen } from '@test-utils'; +import LabelledSelect from './labelled-select'; + +const selectOptions = [ + { id: 'option1', name: 'Option 1', value: 'option1' }, + { id: 'option2', name: 'Option 2', value: 'option2' }, + { id: 'option3', name: 'Option 3', value: 'option3' }, +]; + +describe('LabelledSelect', () => { + it('renders a labelled select', () => { + render( + null} + /> + ); + expect(screen.getByLabelText('Jest select field')).toBeInTheDocument(); + expect(screen.getByRole('combobox')).toHaveValue('option1'); + }); +}); diff --git a/src/components/molecules/forms/labelled-select.tsx b/src/components/molecules/forms/labelled-select.tsx new file mode 100644 index 0000000..442e91a --- /dev/null +++ b/src/components/molecules/forms/labelled-select.tsx @@ -0,0 +1,25 @@ +import Label from '@components/atoms/forms/label'; +import Select, { type SelectProps } from '@components/atoms/forms/select'; +import { FC } from 'react'; + +type LabelledSelectProps = SelectProps & { + label: string; +}; + +const LabelledSelect: FC = ({ + id, + label, + required, + ...props +}) => { + return ( + <> + + null} + /> + ); + expect(screen.getByRole('combobox')).toHaveValue(selected.value); + expect(screen.queryByRole('combobox')).not.toHaveValue( + selectOptions[1].value + ); + expect(screen.queryByRole('combobox')).not.toHaveValue( + selectOptions[2].value + ); + }); +}); diff --git a/src/components/atoms/forms/select.tsx b/src/components/atoms/forms/select.tsx index e434a82..a42dbda 100644 --- a/src/components/atoms/forms/select.tsx +++ b/src/components/atoms/forms/select.tsx @@ -1,13 +1,17 @@ import { ChangeEvent, FC, SetStateAction } from 'react'; import styles from './forms.module.scss'; -type SelectOptions = { +export type SelectOptions = { id: string; name: string; value: string; }; export type SelectProps = { + /** + * Set additional classes. + */ + classes?: string; /** * Field state. Either enabled (false) or disabled (true). */ @@ -43,7 +47,12 @@ export type SelectProps = { * * Render a HTML select element. */ -const Select: FC = ({ options, setValue, ...props }) => { +const Select: FC = ({ + classes = '', + options, + setValue, + ...props +}) => { /** * Update select value when an option is selected. * @param e - The option change event. @@ -65,7 +74,7 @@ const Select: FC = ({ options, setValue, ...props }) => { return ( + setIsTooltipOpened(!isTooltipOpened)} + classes={buttonModifier} + /> + + + ); +}; + +export default SelectWithTooltip; -- cgit v1.2.3 From 61278678ea8a8febee0574cd0f6006492d7b15cb Mon Sep 17 00:00:00 2001 From: Armand Philippot Date: Fri, 8 Apr 2022 22:34:24 +0200 Subject: chore: add a AckeeSelect component --- .../molecules/forms/ackee-select.module.scss | 11 +++ .../molecules/forms/ackee-select.stories.tsx | 32 ++++++++ .../molecules/forms/ackee-select.test.tsx | 23 ++++++ src/components/molecules/forms/ackee-select.tsx | 89 ++++++++++++++++++++++ 4 files changed, 155 insertions(+) create mode 100644 src/components/molecules/forms/ackee-select.module.scss create mode 100644 src/components/molecules/forms/ackee-select.stories.tsx create mode 100644 src/components/molecules/forms/ackee-select.test.tsx create mode 100644 src/components/molecules/forms/ackee-select.tsx (limited to 'src/components/molecules/forms') diff --git a/src/components/molecules/forms/ackee-select.module.scss b/src/components/molecules/forms/ackee-select.module.scss new file mode 100644 index 0000000..87cd9ee --- /dev/null +++ b/src/components/molecules/forms/ackee-select.module.scss @@ -0,0 +1,11 @@ +.wrapper { + display: flex; + flex-flow: row wrap; + align-items: center; + position: relative; +} + +.tooltip { + position: absolute; + bottom: -100%; +} diff --git a/src/components/molecules/forms/ackee-select.stories.tsx b/src/components/molecules/forms/ackee-select.stories.tsx new file mode 100644 index 0000000..a59bfa9 --- /dev/null +++ b/src/components/molecules/forms/ackee-select.stories.tsx @@ -0,0 +1,32 @@ +import { ComponentMeta, ComponentStory } from '@storybook/react'; +import { IntlProvider } from 'react-intl'; +import AckeeSelectComponent from './ackee-select'; + +export default { + title: 'Molecules/Forms', + component: AckeeSelectComponent, + argTypes: { + initialValue: { + control: { + type: 'select', + }, + description: 'Initial selected option.', + options: ['full', 'partial'], + type: { + name: 'string', + required: true, + }, + }, + }, +} as ComponentMeta; + +const Template: ComponentStory = (args) => ( + + + +); + +export const AckeeSelect = Template.bind({}); +AckeeSelect.args = { + initialValue: 'full', +}; diff --git a/src/components/molecules/forms/ackee-select.test.tsx b/src/components/molecules/forms/ackee-select.test.tsx new file mode 100644 index 0000000..e1e6b2d --- /dev/null +++ b/src/components/molecules/forms/ackee-select.test.tsx @@ -0,0 +1,23 @@ +import userEvent from '@testing-library/user-event'; +import { render, screen } from '@test-utils'; +import AckeeSelect from './ackee-select'; + +describe('Select', () => { + it('should correctly set default option', () => { + render(); + expect(screen.getByRole('combobox')).toHaveValue('full'); + expect(screen.queryByRole('combobox')).not.toHaveValue('partial'); + }); + + it('should correctly change value when user choose another option', () => { + render(); + + userEvent.selectOptions( + screen.getByRole('combobox'), + screen.getByRole('option', { name: 'Partial' }) + ); + + expect(screen.getByRole('combobox')).toHaveValue('partial'); + expect(screen.queryByRole('combobox')).not.toHaveValue('full'); + }); +}); diff --git a/src/components/molecules/forms/ackee-select.tsx b/src/components/molecules/forms/ackee-select.tsx new file mode 100644 index 0000000..4a8410c --- /dev/null +++ b/src/components/molecules/forms/ackee-select.tsx @@ -0,0 +1,89 @@ +import { SelectOptions } from '@components/atoms/forms/select'; +import { Dispatch, SetStateAction, useState, VFC } from 'react'; +import { useIntl } from 'react-intl'; +import SelectWithTooltip, { + SelectWithTooltipProps, +} from './select-with-tooltip'; + +export type AckeeOptions = 'full' | 'partial'; + +export type AckeeSelectProps = Pick< + SelectWithTooltipProps, + 'labelClassName' | 'tooltipClassName' +> & { + /** + * A default value for Ackee settings. + */ + initialValue: AckeeOptions; +}; + +/** + * AckeeSelect component + * + * Render a select to set Ackee settings. + */ +const AckeeSelect: VFC = ({ initialValue, ...props }) => { + const intl = useIntl(); + const [value, setValue] = useState(initialValue); + + const ackeeLabel = intl.formatMessage({ + defaultMessage: 'Tracking:', + description: 'AckeeSelect: select label', + id: '2pmylc', + }); + const tooltipTitle = intl.formatMessage({ + defaultMessage: 'Ackee tracking (analytics)', + description: 'AckeeSelect: tooltip title', + id: 'F1EQX3', + }); + const tooltipContent = [ + intl.formatMessage({ + defaultMessage: 'Partial includes only page url, views and duration.', + description: 'AckeeSelect: tooltip message', + id: 'skb4W5', + }), + intl.formatMessage({ + defaultMessage: + 'Full includes all information from partial as well as information about referrer, operating system, device, browser, screen size and language.', + description: 'AckeeSelect: tooltip message', + id: 'Ogccx6', + }), + ]; + const options: SelectOptions[] = [ + { + id: 'partial', + name: intl.formatMessage({ + defaultMessage: 'Partial', + description: 'AckeeSelect: partial option name', + id: 'e/8Kyj', + }), + value: 'partial', + }, + { + id: 'full', + name: intl.formatMessage({ + defaultMessage: 'Full', + description: 'AckeeSelect: full option name', + id: 'PzRpPw', + }), + value: 'full', + }, + ]; + + return ( + >} + {...props} + /> + ); +}; + +export default AckeeSelect; -- cgit v1.2.3 From 0b3146f7278929c4d1b33dd8f94f34e351e5e5a9 Mon Sep 17 00:00:00 2001 From: Armand Philippot Date: Fri, 8 Apr 2022 22:36:24 +0200 Subject: chore: add a Settings modal component --- src/components/atoms/forms/field.stories.tsx | 45 +++++++++--- src/components/atoms/forms/field.tsx | 21 ++++-- src/components/atoms/forms/form.test.tsx | 9 +++ src/components/atoms/forms/form.tsx | 73 ++++++++++++++++++++ src/components/atoms/forms/forms.module.scss | 23 +++---- src/components/atoms/forms/label.module.scss | 17 +++++ src/components/atoms/forms/label.stories.tsx | 42 ++++++++++-- src/components/atoms/forms/label.test.tsx | 2 +- src/components/atoms/forms/label.tsx | 32 +++++++-- src/components/atoms/forms/select.stories.tsx | 44 +++++++++--- src/components/atoms/forms/select.tsx | 25 +++++-- src/components/atoms/forms/toggle.module.scss | 2 +- src/components/atoms/forms/toggle.tsx | 7 +- .../molecules/forms/labelled-field.module.scss | 9 +++ .../molecules/forms/labelled-field.stories.tsx | 33 +++++++-- src/components/molecules/forms/labelled-field.tsx | 34 +++++++-- .../molecules/forms/labelled-select.module.scss | 9 +++ .../molecules/forms/labelled-select.stories.tsx | 80 ++++++++++++++++++++-- src/components/molecules/forms/labelled-select.tsx | 51 ++++++++++++-- .../molecules/forms/motion-toggle.stories.tsx | 15 ++++ src/components/molecules/forms/motion-toggle.tsx | 8 ++- .../molecules/forms/prism-theme-toggle.stories.tsx | 15 ++++ .../molecules/forms/prism-theme-toggle.tsx | 11 ++- .../forms/select-with-tooltip.module.scss | 10 +-- .../forms/select-with-tooltip.stories.tsx | 77 +++++++++++++++++---- .../molecules/forms/select-with-tooltip.tsx | 34 +++++---- .../molecules/forms/theme-toggle.stories.tsx | 15 ++++ src/components/molecules/forms/theme-toggle.tsx | 8 ++- .../organisms/modals/settings-modal.module.scss | 14 ++++ .../organisms/modals/settings-modal.stories.tsx | 31 +++++++++ .../organisms/modals/settings-modal.test.tsx | 34 +++++++++ src/components/organisms/modals/settings-modal.tsx | 51 ++++++++++++++ 32 files changed, 761 insertions(+), 120 deletions(-) create mode 100644 src/components/atoms/forms/form.test.tsx create mode 100644 src/components/atoms/forms/form.tsx create mode 100644 src/components/atoms/forms/label.module.scss create mode 100644 src/components/molecules/forms/labelled-field.module.scss create mode 100644 src/components/molecules/forms/labelled-select.module.scss create mode 100644 src/components/organisms/modals/settings-modal.module.scss create mode 100644 src/components/organisms/modals/settings-modal.stories.tsx create mode 100644 src/components/organisms/modals/settings-modal.test.tsx create mode 100644 src/components/organisms/modals/settings-modal.tsx (limited to 'src/components/molecules/forms') diff --git a/src/components/atoms/forms/field.stories.tsx b/src/components/atoms/forms/field.stories.tsx index 02681e7..ec81922 100644 --- a/src/components/atoms/forms/field.stories.tsx +++ b/src/components/atoms/forms/field.stories.tsx @@ -1,4 +1,5 @@ import { ComponentMeta, ComponentStory } from '@storybook/react'; +import { useState } from 'react'; import FieldComponent from './field'; export default { @@ -7,11 +8,35 @@ export default { args: { disabled: false, required: false, - setValue: () => null, type: 'text', - value: '', }, argTypes: { + 'aria-labelledby': { + control: { + type: 'text', + }, + description: 'One or more ids that refers to the field name.', + table: { + category: 'Accessibility', + }, + type: { + name: 'string', + required: false, + }, + }, + className: { + control: { + type: 'text', + }, + description: 'Add classnames to the field.', + table: { + category: 'Styles', + }, + type: { + name: 'string', + required: false, + }, + }, disabled: { control: { type: 'boolean', @@ -148,7 +173,7 @@ export default { }, value: { control: { - type: 'text', + type: null, }, description: 'Field value.', type: { @@ -159,14 +184,18 @@ export default { }, } as ComponentMeta; -const Template: ComponentStory = (args) => ( - -); +const Template: ComponentStory = ({ + value: _value, + setValue: _setValue, + ...args +}) => { + const [value, setValue] = useState(''); + + return ; +}; export const Field = Template.bind({}); Field.args = { id: 'field-storybook', name: 'field-storybook', - setValue: () => null, - value: '', }; diff --git a/src/components/atoms/forms/field.tsx b/src/components/atoms/forms/field.tsx index 513d2ba..2e75d0f 100644 --- a/src/components/atoms/forms/field.tsx +++ b/src/components/atoms/forms/field.tsx @@ -1,4 +1,4 @@ -import { ChangeEvent, FC, SetStateAction } from 'react'; +import { ChangeEvent, SetStateAction, VFC } from 'react'; import styles from './forms.module.scss'; export type FieldType = @@ -13,6 +13,14 @@ export type FieldType = | 'url'; export type FieldProps = { + /** + * One or more ids that refers to the field name. + */ + 'aria-labelledby'?: string; + /** + * Add classnames to the field. + */ + className?: string; /** * Field state. Either enabled (false) or disabled (true). */ @@ -64,7 +72,12 @@ export type FieldProps = { * * Render either an input or a textarea. */ -const Field: FC = ({ setValue, type, ...props }) => { +const Field: VFC = ({ + className = '', + setValue, + type, + ...props +}) => { /** * Update select value when an option is selected. * @param e - The option change event. @@ -78,14 +91,14 @@ const Field: FC = ({ setValue, type, ...props }) => { return type === 'textarea' ? (