Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(documentation): add react components package docs #4669

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

leagrdv
Copy link
Contributor

@leagrdv leagrdv commented Feb 13, 2025

No description provided.

@leagrdv leagrdv requested review from a team as code owners February 13, 2025 14:20
@leagrdv leagrdv requested a review from alizedebray February 13, 2025 14:20
@leagrdv leagrdv linked an issue Feb 13, 2025 that may be closed by this pull request
1 task
Copy link

changeset-bot bot commented Feb 13, 2025

🦋 Changeset detected

Latest commit: 76b24b6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 16 packages
Name Type
@swisspost/design-system-components Patch
@swisspost/design-system-components-angular-workspace Patch
@swisspost/design-system-components-react Patch
@swisspost/design-system-documentation Patch
@swisspost/design-system-components-angular Patch
@swisspost/design-system-nextjs-integration Patch
@swisspost/design-system-styles Patch
@swisspost/design-system-tokens Patch
@swisspost/design-system-intranet-header Patch
@swisspost/design-system-icons Patch
@swisspost/design-system-migrations Patch
@swisspost/design-system-styles-primeng Patch
@swisspost/internet-header Patch
@swisspost/design-system-intranet-header-workspace Patch
@swisspost/design-system-styles-primeng-workspace Patch
@swisspost/design-system-intranet-header-showcase Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@swisspost-bot
Copy link
Contributor

swisspost-bot commented Feb 13, 2025

Related Previews

.changeset/nasty-plants-shop.md Outdated Show resolved Hide resolved
Comment on lines +3 to +11
import { PostComponent } from '@swisspost/design-system-components-react';

function App() {
return (
<>
<PostComponent>My component content</PostComponent>
</>
);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use the post-icon component as an example as we have in the components for Angular docs:

Suggested change
import { PostComponent } from '@swisspost/design-system-components-react';
function App() {
return (
<>
<PostComponent>My component content</PostComponent>
</>
);
}
import { PostIcon } from '@swisspost/design-system-components-react';
function App() {
return (
<PostIcon name="iconName">My component content</PostIcon>
);
}

leagrdv and others added 2 commits February 14, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the react components package
3 participants