Skip to content

Commit 943dec9

Browse files
committed
feat: add Placeholder story with beta labeling
1 parent 2865af7 commit 943dec9

3 files changed

Lines changed: 45 additions & 8 deletions

File tree

documentation/how-to/BETA_RELEASE_GUIDE.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,28 +78,27 @@ import { Placeholder } from '@equinor/eds-core-react/next'
7878

7979
## Viewing Beta Components in Storybook
8080

81-
Beta components are **visible in production Storybook** under the **"EDS 2.0"** section with "next" badges. This allows everyone to:
81+
Beta components are **visible in production Storybook** under the **"EDS 2.0 (beta)"** section. This allows everyone to:
8282

8383
- 👀 See what's coming in EDS 2.0
8484
- 📖 Read documentation and API specs
8585
- 🎨 View design implementations
8686
- 💬 Provide feedback before stable release
8787

88-
### Storybook Labeling Tips
88+
### Storybook Naming Convention
8989

90-
Add a visual indicator in story titles so teams immediately know the component is in beta:
90+
Use the `EDS 2.0 (beta)` prefix in story titles so teams immediately know the component is in beta:
9191

9292
```typescript
9393
// In component stories
9494
export default {
9595
title: 'EDS 2.0 (beta)/Inputs/Button',
96-
parameters: {
97-
badges: ['beta', 'next'],
98-
},
96+
component: Button,
97+
tags: ['beta'],
9998
}
10099
```
101100

102-
Use consistent naming (e.g., `EDS 2.0 (beta)`) so search groups every beta story together.
101+
The `(beta)` suffix in the title provides a clear visual indicator in the sidebar, and the `tags` property enables filtering.
103102

104103
**To actually use these components**, you must install the beta version:
105104

packages/eds-core-react/.storybook/preview.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const preview = {
1111
'Introduction',
1212
'EdsProvider',
1313
'EDS 2.0 (beta)',
14+
['About', '*'],
1415
'Data Display',
1516
'Feedback',
1617
'Inputs',
@@ -26,6 +27,6 @@ const preview = {
2627
},
2728
},
2829

29-
tags: ['autodocs']
30+
tags: ['autodocs'],
3031
}
3132
export default preview
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import { Placeholder, PlaceholderProps } from './Placeholder'
2+
import { StoryFn, Meta } from '@storybook/react-vite'
3+
4+
const meta: Meta<typeof Placeholder> = {
5+
title: 'EDS 2.0 (beta)/Placeholder',
6+
component: Placeholder,
7+
tags: ['beta'],
8+
parameters: {
9+
docs: {
10+
description: {
11+
component: `
12+
**⚠️ Beta Component** - This component is under active development and may have breaking changes.
13+
14+
\`\`\`bash
15+
npm install @equinor/eds-core-react@beta
16+
\`\`\`
17+
18+
\`\`\`tsx
19+
import { Placeholder } from '@equinor/eds-core-react/next'
20+
\`\`\`
21+
22+
This is a placeholder component for testing the \`/next\` entry point.
23+
It will be removed once real EDS 2.0 components are added.
24+
`,
25+
},
26+
},
27+
},
28+
}
29+
30+
export default meta
31+
32+
export const Introduction: StoryFn<PlaceholderProps> = (args) => {
33+
return <Placeholder {...args} />
34+
}
35+
Introduction.args = {
36+
text: 'Hello from EDS 2.0!',
37+
}

0 commit comments

Comments
 (0)