From a76c8ecfa193add5a9c7662283b57863b74e156c Mon Sep 17 00:00:00 2001 From: George Marshall Date: Tue, 29 Nov 2022 13:00:51 -0800 Subject: [PATCH] HelpText house keeping updates (#16681) --- .../component-library/help-text/README.mdx | 19 +++++++++------ .../__snapshots__/help-text.test.js.snap | 11 +++++++++ .../component-library/help-text/help-text.js | 2 +- .../help-text/help-text.stories.js | 3 ++- .../help-text/help-text.test.js | 23 ++++++++----------- 5 files changed, 36 insertions(+), 22 deletions(-) create mode 100644 ui/components/component-library/help-text/__snapshots__/help-text.test.js.snap diff --git a/ui/components/component-library/help-text/README.mdx b/ui/components/component-library/help-text/README.mdx index 03c2cf50a..d204522ec 100644 --- a/ui/components/component-library/help-text/README.mdx +++ b/ui/components/component-library/help-text/README.mdx @@ -1,5 +1,7 @@ import { Story, Canvas, ArgsTable } from '@storybook/addon-docs'; +import { Text } from '..'; + import { HelpText } from './help-text'; # HelpText @@ -12,13 +14,17 @@ The `HelpText` is intended to be used as the help or error text under a form ele ## Props -The `HelpText` accepts all props below as well as all [Text](/docs/ui-components-component-library-text-text-stories-js--default-story#props) and [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) component props. +The `HelpText` accepts all props below as well as all [Box](/docs/ui-components-ui-box-box-stories-js--default-story#props) component props +`HelpText` accepts all [Text](/docs/ui-components-component-library-text-text-stories-js--default-story#props) component props + + + ### Children -The `children` of the `HelpText` can be plain text or react nodes. +The `children` of the `HelpText` can be plain text or react nodes @@ -26,8 +32,7 @@ The `children` of the `HelpText` can be plain text or react nodes. ```jsx import { SIZES, COLORS } from '../../../helpers/constants/design-system'; -import { Icon, ICON_NAMES } from '../../ui/components/component-library'; -import { HelpText } from '../../ui/components/component-library'; +import { HelpText, Icon, ICON_NAMES } from '../../component-library'; Plain text @@ -43,14 +48,14 @@ import { HelpText } from '../../ui/components/component-library'; ### Error -Use the `error` prop to show the `HelpText` in error state. +Use the `error` prop to show the `HelpText` in error state ```jsx -import { HelpText } from '../../ui/components/component-library'; +import { HelpText } from '../../component-library'; This HelpText in error state; ``` @@ -65,7 +70,7 @@ It may be useful to change the color of the `HelpText`. Use the `color` prop and ```jsx import { COLORS } from '../../../helpers/constants/design-system'; -import { HelpText } from '../../ui/components/component-library'; +import { HelpText } from '../../component-library'; diff --git a/ui/components/component-library/help-text/__snapshots__/help-text.test.js.snap b/ui/components/component-library/help-text/__snapshots__/help-text.test.js.snap new file mode 100644 index 000000000..7c8eff49c --- /dev/null +++ b/ui/components/component-library/help-text/__snapshots__/help-text.test.js.snap @@ -0,0 +1,11 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`HelpText should render with text inside the HelpText 1`] = ` +
+ + help text + +
+`; diff --git a/ui/components/component-library/help-text/help-text.js b/ui/components/component-library/help-text/help-text.js index 2eeb66841..316d4fbb3 100644 --- a/ui/components/component-library/help-text/help-text.js +++ b/ui/components/component-library/help-text/help-text.js @@ -18,8 +18,8 @@ export const HelpText = ({ ...props }) => ( { it('should render with text inside the HelpText', () => { - const { getByText } = render(help text); + const { getByText, container } = render(help text); expect(getByText('help text')).toBeDefined(); + expect(getByText('help text')).toHaveClass('mm-help-text'); + expect(container).toMatchSnapshot(); + }); + it('should render with and additional className', () => { + const { getByText } = render( + help text, + ); + expect(getByText('help text')).toHaveClass('mm-help-text test-class'); }); it('should render with react nodes inside the HelpText', () => { const { getByText, getByTestId } = render( @@ -20,19 +28,8 @@ describe('HelpText', () => { expect(getByText('help text')).toBeDefined(); expect(getByTestId('icon')).toBeDefined(); }); - it('should render with and additional className', () => { - const { getByText } = render( - help text, - ); - expect(getByText('help text')).toBeDefined(); - expect(getByText('help text')).toHaveClass('test-class'); - }); it('should render with error state', () => { - const { getByText } = render( - <> - error - , - ); + const { getByText } = render(error); expect(getByText('error')).toHaveClass('text--color-error-default'); }); it('should render with different colors', () => {