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.

Sign up for GitHub

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

docs: add tour and badge component to stories #500

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −3
Open

docs: add tour and badge component to stories #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cd108b
docs: add tour and badge to canvas stories
gabyzif Nov 18, 2024
97c1042
Merge branch 'main' into docs/badge-tour
gabyzif Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/components/Data Display/Badge/Documentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Meta, Canvas } from '@storybook/blocks'

import * as BadgeStories from '../../../../src/components/data-display/Badge/Badge.stories'
import * as BadgeStories from '../../../../src/components/data-display/Badge/Badge.stories';

<Meta of={BadgeStories} />

Expand All @@ -25,6 +25,8 @@ Use **Badge** when a status needs to be displayed next to an element in a compac

### [Status Badge](https://mparticle.github.io/aquarium/?path=/story/components-data-display-badge--example-status)

<Canvas of={BadgeStories.ExampleStatus} />

#### When to Use

For displaying status with accompanying text (e.g., "Active," "Failed," or "Draft"), use the **Status Badge**. This provides both a visual indicator and descriptive text to communicate the item's state.
Expand Down
4 changes: 2 additions & 2 deletions docs/components/Data Display/Tour/Documentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Meta, Canvas } from '@storybook/blocks'

import * as TourStories from '../../../../src/components/data-display/Tour/Tour.stories'
import TourMeta, * as TourStories from '../../../../src/components/data-display/Tour/Tour.stories';

<Meta of={TourStories} />

Expand All @@ -24,4 +24,4 @@ Use the Tour component when:

{/* Documentation goes here */}

<Canvas meta={TourStories.default} />
<Canvas of={TourStories.ExampleNavLogo} />
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we make this opened by default upon loading of the docs? I recall Sonia asking for this.