From d17d894f398650209c0ddd29502308de8c07bd93 Mon Sep 17 00:00:00 2001 From: Armand Philippot Date: Wed, 27 Sep 2023 18:43:25 +0200 Subject: feat(components): add Article, Aside, Footer, Header, Main & Nav Some components have been renamed to be able to create Footer, Header and Nav. --- src/components/atoms/index.ts | 1 + .../atoms/layout/article/article.stories.tsx | 34 ++++++++++++ .../atoms/layout/article/article.test.tsx | 13 +++++ src/components/atoms/layout/article/article.tsx | 23 +++++++++ src/components/atoms/layout/article/index.ts | 1 + .../atoms/layout/aside/aside.stories.tsx | 34 ++++++++++++ src/components/atoms/layout/aside/aside.test.tsx | 13 +++++ src/components/atoms/layout/aside/aside.tsx | 23 +++++++++ src/components/atoms/layout/aside/index.ts | 1 + .../atoms/layout/footer/footer.stories.tsx | 34 ++++++++++++ src/components/atoms/layout/footer/footer.test.tsx | 13 +++++ src/components/atoms/layout/footer/footer.tsx | 23 +++++++++ src/components/atoms/layout/footer/index.ts | 1 + .../atoms/layout/header/header.stories.tsx | 34 ++++++++++++ src/components/atoms/layout/header/header.test.tsx | 13 +++++ src/components/atoms/layout/header/header.tsx | 23 +++++++++ src/components/atoms/layout/header/index.ts | 1 + src/components/atoms/layout/index.ts | 6 ++- src/components/atoms/layout/main.stories.tsx | 58 --------------------- src/components/atoms/layout/main.test.tsx | 13 ----- src/components/atoms/layout/main.tsx | 17 ------ src/components/atoms/layout/main/index.ts | 1 + src/components/atoms/layout/main/main.stories.tsx | 57 ++++++++++++++++++++ src/components/atoms/layout/main/main.test.tsx | 13 +++++ src/components/atoms/layout/main/main.tsx | 29 +++++++++++ src/components/atoms/layout/nav/index.ts | 1 + src/components/atoms/layout/nav/nav.stories.tsx | 34 ++++++++++++ src/components/atoms/layout/nav/nav.test.tsx | 13 +++++ src/components/atoms/layout/nav/nav.tsx | 23 +++++++++ src/components/atoms/layout/sidebar.module.scss | 12 ----- src/components/atoms/layout/sidebar.stories.tsx | 60 ---------------------- src/components/atoms/layout/sidebar.test.tsx | 12 ----- src/components/atoms/layout/sidebar.tsx | 26 ---------- src/components/atoms/sidebar/index.ts | 1 + src/components/atoms/sidebar/sidebar.module.scss | 12 +++++ src/components/atoms/sidebar/sidebar.stories.tsx | 60 ++++++++++++++++++++++ src/components/atoms/sidebar/sidebar.test.tsx | 12 +++++ src/components/atoms/sidebar/sidebar.tsx | 22 ++++++++ 38 files changed, 568 insertions(+), 199 deletions(-) create mode 100644 src/components/atoms/layout/article/article.stories.tsx create mode 100644 src/components/atoms/layout/article/article.test.tsx create mode 100644 src/components/atoms/layout/article/article.tsx create mode 100644 src/components/atoms/layout/article/index.ts create mode 100644 src/components/atoms/layout/aside/aside.stories.tsx create mode 100644 src/components/atoms/layout/aside/aside.test.tsx create mode 100644 src/components/atoms/layout/aside/aside.tsx create mode 100644 src/components/atoms/layout/aside/index.ts create mode 100644 src/components/atoms/layout/footer/footer.stories.tsx create mode 100644 src/components/atoms/layout/footer/footer.test.tsx create mode 100644 src/components/atoms/layout/footer/footer.tsx create mode 100644 src/components/atoms/layout/footer/index.ts create mode 100644 src/components/atoms/layout/header/header.stories.tsx create mode 100644 src/components/atoms/layout/header/header.test.tsx create mode 100644 src/components/atoms/layout/header/header.tsx create mode 100644 src/components/atoms/layout/header/index.ts delete mode 100644 src/components/atoms/layout/main.stories.tsx delete mode 100644 src/components/atoms/layout/main.test.tsx delete mode 100644 src/components/atoms/layout/main.tsx create mode 100644 src/components/atoms/layout/main/index.ts create mode 100644 src/components/atoms/layout/main/main.stories.tsx create mode 100644 src/components/atoms/layout/main/main.test.tsx create mode 100644 src/components/atoms/layout/main/main.tsx create mode 100644 src/components/atoms/layout/nav/index.ts create mode 100644 src/components/atoms/layout/nav/nav.stories.tsx create mode 100644 src/components/atoms/layout/nav/nav.test.tsx create mode 100644 src/components/atoms/layout/nav/nav.tsx delete mode 100644 src/components/atoms/layout/sidebar.module.scss delete mode 100644 src/components/atoms/layout/sidebar.stories.tsx delete mode 100644 src/components/atoms/layout/sidebar.test.tsx delete mode 100644 src/components/atoms/layout/sidebar.tsx create mode 100644 src/components/atoms/sidebar/index.ts create mode 100644 src/components/atoms/sidebar/sidebar.module.scss create mode 100644 src/components/atoms/sidebar/sidebar.stories.tsx create mode 100644 src/components/atoms/sidebar/sidebar.test.tsx create mode 100644 src/components/atoms/sidebar/sidebar.tsx (limited to 'src/components/atoms') diff --git a/src/components/atoms/index.ts b/src/components/atoms/index.ts index 672440c..e0041cc 100644 --- a/src/components/atoms/index.ts +++ b/src/components/atoms/index.ts @@ -8,3 +8,4 @@ export * from './links'; export * from './lists'; export * from './loaders'; export * from './modal'; +export * from './sidebar'; diff --git a/src/components/atoms/layout/article/article.stories.tsx b/src/components/atoms/layout/article/article.stories.tsx new file mode 100644 index 0000000..4c5b158 --- /dev/null +++ b/src/components/atoms/layout/article/article.stories.tsx @@ -0,0 +1,34 @@ +import type { ComponentMeta, ComponentStory } from '@storybook/react'; +import { Article as ArticleComponent } from './article'; + +/** + * Article - Storybook Meta + */ +export default { + title: 'Atoms/Layout', + component: ArticleComponent, + argTypes: { + children: { + control: { + type: 'text', + }, + description: 'The contents.', + type: { + name: 'string', + required: true, + }, + }, + }, +} as ComponentMeta; + +const Template: ComponentStory = (args) => ( + +); + +/** + * Layout Stories - Article + */ +export const Article = Template.bind({}); +Article.args = { + children: 'The article content.', +}; diff --git a/src/components/atoms/layout/article/article.test.tsx b/src/components/atoms/layout/article/article.test.tsx new file mode 100644 index 0000000..2412fe3 --- /dev/null +++ b/src/components/atoms/layout/article/article.test.tsx @@ -0,0 +1,13 @@ +import { describe, expect, it } from '@jest/globals'; +import { render, screen as rtlScreen } from '@testing-library/react'; +import { Article } from './article'; + +describe('Article', () => { + it('renders the contents of an article', () => { + const children = 'The article content.'; + + render(
{children}
); + + expect(rtlScreen.getByRole('article')).toHaveTextContent(children); + }); +}); diff --git a/src/components/atoms/layout/article/article.tsx b/src/components/atoms/layout/article/article.tsx new file mode 100644 index 0000000..8611e20 --- /dev/null +++ b/src/components/atoms/layout/article/article.tsx @@ -0,0 +1,23 @@ +import { + type ForwardRefRenderFunction, + type HTMLAttributes, + type ReactNode, + forwardRef, +} from 'react'; + +export type ArticleProps = HTMLAttributes & { + /** + * The article contents. + */ + children: ReactNode; +}; + +const ArticleWithRef: ForwardRefRenderFunction = ( + props, + ref +) =>
; + +/** + * Article component. + */ +export const Article = forwardRef(ArticleWithRef); diff --git a/src/components/atoms/layout/article/index.ts b/src/components/atoms/layout/article/index.ts new file mode 100644 index 0000000..a8e7c14 --- /dev/null +++ b/src/components/atoms/layout/article/index.ts @@ -0,0 +1 @@ +export * from './article'; diff --git a/src/components/atoms/layout/aside/aside.stories.tsx b/src/components/atoms/layout/aside/aside.stories.tsx new file mode 100644 index 0000000..a394d1b --- /dev/null +++ b/src/components/atoms/layout/aside/aside.stories.tsx @@ -0,0 +1,34 @@ +import type { ComponentMeta, ComponentStory } from '@storybook/react'; +import { Aside as AsideComponent } from './aside'; + +/** + * Aside - Storybook Meta + */ +export default { + title: 'Atoms/Layout', + component: AsideComponent, + argTypes: { + children: { + control: { + type: 'text', + }, + description: 'The contents.', + type: { + name: 'string', + required: true, + }, + }, + }, +} as ComponentMeta; + +const Template: ComponentStory = (args) => ( + +); + +/** + * Layout Stories - Aside + */ +export const Aside = Template.bind({}); +Aside.args = { + children: 'The aside content.', +}; diff --git a/src/components/atoms/layout/aside/aside.test.tsx b/src/components/atoms/layout/aside/aside.test.tsx new file mode 100644 index 0000000..5c55589 --- /dev/null +++ b/src/components/atoms/layout/aside/aside.test.tsx @@ -0,0 +1,13 @@ +import { describe, expect, it } from '@jest/globals'; +import { render, screen as rtlScreen } from '@testing-library/react'; +import { Aside } from './aside'; + +describe('Aside', () => { + it('renders the contents of an aside', () => { + const children = 'The aside content.'; + + render(); + + expect(rtlScreen.getByRole('complementary')).toHaveTextContent(children); + }); +}); diff --git a/src/components/atoms/layout/aside/aside.tsx b/src/components/atoms/layout/aside/aside.tsx new file mode 100644 index 0000000..92a9bf2 --- /dev/null +++ b/src/components/atoms/layout/aside/aside.tsx @@ -0,0 +1,23 @@ +import { + type ForwardRefRenderFunction, + type HTMLAttributes, + type ReactNode, + forwardRef, +} from 'react'; + +export type AsideProps = HTMLAttributes & { + /** + * The aside contents. + */ + children: ReactNode; +}; + +const AsideWithRef: ForwardRefRenderFunction = ( + props, + ref +) =>