From af77c1e76b34e4f15844165944087ba1cd8ef51e Mon Sep 17 00:00:00 2001 From: leagrdv Date: Thu, 13 Feb 2025 15:20:14 +0100 Subject: [PATCH 1/4] chore(documentation): add react components package docs --- .changeset/nasty-plants-shop.md | 5 ++ .../components-react.docs.mdx | 46 +++++++++++++++++++ .../components-react.stories.ts | 16 +++++++ .../react-app-module.sample.ts | 11 +++++ 4 files changed, 78 insertions(+) create mode 100644 .changeset/nasty-plants-shop.md create mode 100644 packages/documentation/src/stories/packages/components-react/components-react.docs.mdx create mode 100644 packages/documentation/src/stories/packages/components-react/components-react.stories.ts create mode 100644 packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts diff --git a/.changeset/nasty-plants-shop.md b/.changeset/nasty-plants-shop.md new file mode 100644 index 0000000000..77872d810f --- /dev/null +++ b/.changeset/nasty-plants-shop.md @@ -0,0 +1,5 @@ +--- +'@swisspost/design-system-components': patch +--- + +Added documentation for the `design-system-components-react` package diff --git a/packages/documentation/src/stories/packages/components-react/components-react.docs.mdx b/packages/documentation/src/stories/packages/components-react/components-react.docs.mdx new file mode 100644 index 0000000000..450e0ae9b4 --- /dev/null +++ b/packages/documentation/src/stories/packages/components-react/components-react.docs.mdx @@ -0,0 +1,46 @@ +import { Meta, Source } from '@storybook/blocks'; +import * as PackageStories from './components-react.stories'; +import ReactAppModuleSample from './react-app-module.sample.ts?raw'; +import changelog from '@/../../components-react/CHANGELOG.md?raw'; +import PackageDocs from '@/shared/packages-docs-layout.mdx'; + + + +# @swisspost/design-system-components-react + +[![npm version](https://badge.fury.io/js/@swisspost%2Fdesign-system-components-react.svg)](https://badge.fury.io/js/@swisspost%2Fdesign-system-components-react) + +
The Design System React Components, ready for use in your React project.
+ + + ## Dependencies + +
+ + + + + + + + + + + + + + +
VersionReact
9.x18.x
+ +
+ +## Installation + + + +## Usage + +Importing the components to your project. + + + diff --git a/packages/documentation/src/stories/packages/components-react/components-react.stories.ts b/packages/documentation/src/stories/packages/components-react/components-react.stories.ts new file mode 100644 index 0000000000..32a1b00bb0 --- /dev/null +++ b/packages/documentation/src/stories/packages/components-react/components-react.stories.ts @@ -0,0 +1,16 @@ +import { StoryObj } from '@storybook/web-components'; +import { MetaExtended } from '@root/types'; + +const meta: MetaExtended = { + id: '13b9c7f1-993d-4348-a3b7-a7ceb92fd5c7', + title: 'Packages/Components for React', + parameters: { + badges: [], + }, +}; + +export default meta; + +type Story = StoryObj; + +export const Default: Story = {}; diff --git a/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts b/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts new file mode 100644 index 0000000000..854666fda1 --- /dev/null +++ b/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts @@ -0,0 +1,11 @@ +// app.tsx + +import { PostComponent } from '@swisspost/design-system-components-react'; + +function App() { + return ( + <> + My component content + + ); +} From fd65f9a7e5300e51843eddc780313627b6b8096e Mon Sep 17 00:00:00 2001 From: Lea Date: Fri, 14 Feb 2025 15:32:10 +0100 Subject: [PATCH 2/4] Update .changeset/nasty-plants-shop.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alizé Debray <33580481+alizedebray@users.noreply.github.com> --- .changeset/nasty-plants-shop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/nasty-plants-shop.md b/.changeset/nasty-plants-shop.md index 77872d810f..f3bbd6c548 100644 --- a/.changeset/nasty-plants-shop.md +++ b/.changeset/nasty-plants-shop.md @@ -2,4 +2,4 @@ '@swisspost/design-system-components': patch --- -Added documentation for the `design-system-components-react` package +Added documentation for the `design-system-components-react` package. From 76b24b6bf4f67b7f485802b9a31f96a4244a7852 Mon Sep 17 00:00:00 2001 From: Lea Date: Fri, 14 Feb 2025 15:32:17 +0100 Subject: [PATCH 3/4] Update packages/documentation/src/stories/packages/components-react/components-react.stories.ts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alizé Debray <33580481+alizedebray@users.noreply.github.com> --- .../packages/components-react/components-react.stories.ts | 3 --- 1 file changed, 3 deletions(-) diff --git a/packages/documentation/src/stories/packages/components-react/components-react.stories.ts b/packages/documentation/src/stories/packages/components-react/components-react.stories.ts index 32a1b00bb0..efee253f0c 100644 --- a/packages/documentation/src/stories/packages/components-react/components-react.stories.ts +++ b/packages/documentation/src/stories/packages/components-react/components-react.stories.ts @@ -4,9 +4,6 @@ import { MetaExtended } from '@root/types'; const meta: MetaExtended = { id: '13b9c7f1-993d-4348-a3b7-a7ceb92fd5c7', title: 'Packages/Components for React', - parameters: { - badges: [], - }, }; export default meta; From 83119c0eed4038bebd81ab9ad9b0459313aca6c5 Mon Sep 17 00:00:00 2001 From: leagrdv Date: Mon, 17 Feb 2025 10:56:47 +0100 Subject: [PATCH 4/4] update with post icon --- .../packages/components-react/react-app-module.sample.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts b/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts index 854666fda1..09f827b035 100644 --- a/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts +++ b/packages/documentation/src/stories/packages/components-react/react-app-module.sample.ts @@ -1,11 +1,11 @@ // app.tsx -import { PostComponent } from '@swisspost/design-system-components-react'; +import { PostIcon } from '@swisspost/design-system-components-react'; function App() { return ( <> - My component content + ); }