Skip to content

Commit 3a40c56

Browse files
authored
Merge pull request #121 from ComponentDriven/shilman/add-inactive-note
README: Add note about inactive status
2 parents b832db2 + 186239d commit 3a40c56

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1+
> **NOTE** This repo is inactive. The code from this repo lives in the [Storybook monorepo](https://github.com/storybookjs/storybook/tree/next/code/core/src/csf) and is no longer published as a standalone package. If you depend on the `@storybook/csf` package directly, please file an issue on this repo explaining your use case. We'll be figuring out a longer-term solution over the coming months.
2+
13
<img src="https://user-images.githubusercontent.com/42671/89649515-eceafc00-d88e-11ea-9728-5ef80cdf8462.png" width="321px" height="236px" />
24

35
# Component Story Format (CSF)
46

57
### Why a standard format?
8+
69
Components have risen to dominate the UI landscape. There are new component-oriented tools for development, testing, design, and prototyping. These tools engage in the creation and consumption of components and component examples (a.k.a. stories). But each tool has its own proprietary format because a simple, platform-agnostic way to express component examples doesn't yet exist.
710

811
### The "Story" is the source of truth for a component.
12+
913
A story is a code snippet that renders an example of a component in a specific state. Think about it like a "[user story](https://en.wikipedia.org/wiki/User_story)".
1014

1115
It uses the production code shipped to users, making it the most accurate representation of a component example. What's more, stories are expressed in the view layer you use to build your app.
1216

13-
1417
### Component Story Format
18+
1519
The Component Story Format is an open standard for component examples based on JavaScript ES6 modules. This enables interoperation between development, testing, and design tools.
1620

1721
```js
@@ -34,12 +38,10 @@ export const emoji = () => <Button>😀😎👍💯</Button>;
3438

3539
**Compatible with:** [Jest](https://jestjs.io/), [Enzyme](https://enzymejs.github.io/enzyme), [Testing Library](https://testing-library.com), [Cypress](https://www.cypress.io/), [Playwright](https://playwright.dev/), [Mocha](https://mochajs.org), etc.
3640

37-
3841
## CSF utilities
3942

4043
A minimal set of utility functions for dealing with [Component Story Format (CSF)](https://storybook.js.org/docs/formats/component-story-format/).
4144

42-
4345
### Install
4446

4547
```sh

0 commit comments

Comments
 (0)