aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/layout/main
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2023-09-27 18:43:25 +0200
committerArmand Philippot <git@armandphilippot.com>2023-10-24 12:25:00 +0200
commitd17d894f398650209c0ddd29502308de8c07bd93 (patch)
tree858402dfd362e74686d25fec155f247ad3217635 /src/components/atoms/layout/main
parent7255d25f6834a208c0ed44636356cc260f6ab6ba (diff)
feat(components): add Article, Aside, Footer, Header, Main & Nav
Some components have been renamed to be able to create Footer, Header and Nav.
Diffstat (limited to 'src/components/atoms/layout/main')
-rw-r--r--src/components/atoms/layout/main/index.ts1
-rw-r--r--src/components/atoms/layout/main/main.stories.tsx57
-rw-r--r--src/components/atoms/layout/main/main.test.tsx13
-rw-r--r--src/components/atoms/layout/main/main.tsx29
4 files changed, 100 insertions, 0 deletions
diff --git a/src/components/atoms/layout/main/index.ts b/src/components/atoms/layout/main/index.ts
new file mode 100644
index 0000000..aad1ca8
--- /dev/null
+++ b/src/components/atoms/layout/main/index.ts
@@ -0,0 +1 @@
+export * from './main';
diff --git a/src/components/atoms/layout/main/main.stories.tsx b/src/components/atoms/layout/main/main.stories.tsx
new file mode 100644
index 0000000..6a22ed5
--- /dev/null
+++ b/src/components/atoms/layout/main/main.stories.tsx
@@ -0,0 +1,57 @@
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
+import { Main as MainComponent } from './main';
+
+/**
+ * Main - Storybook Meta
+ */
+export default {
+ title: 'Atoms/Layout',
+ component: MainComponent,
+ argTypes: {
+ children: {
+ control: {
+ type: 'text',
+ },
+ description: 'The content.',
+ type: {
+ name: 'string',
+ required: true,
+ },
+ },
+ className: {
+ control: {
+ type: 'text',
+ },
+ description: 'Set additional classnames to the main element.',
+ table: {
+ category: 'Styles',
+ },
+ type: {
+ name: 'string',
+ required: false,
+ },
+ },
+ id: {
+ control: {
+ type: 'text',
+ },
+ description: 'The main element id.',
+ type: {
+ name: 'string',
+ required: true,
+ },
+ },
+ },
+} as ComponentMeta<typeof MainComponent>;
+
+const Template: ComponentStory<typeof MainComponent> = (args) => (
+ <MainComponent {...args} />
+);
+
+/**
+ * Layout Stories - Main
+ */
+export const Main = Template.bind({});
+Main.args = {
+ children: 'The main content.',
+};
diff --git a/src/components/atoms/layout/main/main.test.tsx b/src/components/atoms/layout/main/main.test.tsx
new file mode 100644
index 0000000..ffd4e2d
--- /dev/null
+++ b/src/components/atoms/layout/main/main.test.tsx
@@ -0,0 +1,13 @@
+import { describe, expect, it } from '@jest/globals';
+import { render, screen as rtlScreen } from '@testing-library/react';
+import { Main } from './main';
+
+describe('Main', () => {
+ it('renders the contents of the main element', () => {
+ const children = 'The main content.';
+
+ render(<Main>{children}</Main>);
+
+ expect(rtlScreen.getByRole('main')).toHaveTextContent(children);
+ });
+});
diff --git a/src/components/atoms/layout/main/main.tsx b/src/components/atoms/layout/main/main.tsx
new file mode 100644
index 0000000..5854900
--- /dev/null
+++ b/src/components/atoms/layout/main/main.tsx
@@ -0,0 +1,29 @@
+import {
+ forwardRef,
+ type HTMLAttributes,
+ type ReactNode,
+ type ForwardRefRenderFunction,
+} from 'react';
+
+export type MainProps = HTMLAttributes<HTMLElement> & {
+ /**
+ * The main body.
+ */
+ children: ReactNode;
+};
+
+const MainWithRef: ForwardRefRenderFunction<HTMLElement, MainProps> = (
+ { children, ...props },
+ ref
+) => (
+ <main {...props} ref={ref}>
+ {children}
+ </main>
+);
+
+/**
+ * Main component
+ *
+ * Render a main element.
+ */
+export const Main = forwardRef(MainWithRef);