Added core files.
This commit is contained in:
parent
24bf71d7f5
commit
89ce6c8e80
GPG key ID:
27F3B6855AFD40A4
42 changed files with 1476 additions and 6 deletions
10
.gitignore
vendored
Normal file
10
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
node_modules/
|
||||||
|
storybook-static/
|
||||||
|
build-storybook.log
|
||||||
|
.DS_Store
|
||||||
|
.env
|
||||||
|
.yarn
|
||||||
|
!.yarn/plugins
|
||||||
|
!.yarn/releases
|
||||||
|
!.yarn/sdks
|
||||||
|
!.yarn/versions
|
||||||
1
.prettierignore
Normal file
1
.prettierignore
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
dist
|
||||||
1
.prettierrc
Normal file
1
.prettierrc
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{}
|
||||||
15
.storybook/local-preset.js
Normal file
15
.storybook/local-preset.js
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
/**
|
||||||
|
* to load the built addon in this test Storybook
|
||||||
|
*/
|
||||||
|
function previewAnnotations(entry = []) {
|
||||||
|
return [...entry, require.resolve("../dist/preview.mjs")];
|
||||||
|
}
|
||||||
|
|
||||||
|
function managerEntries(entry = []) {
|
||||||
|
return [...entry, require.resolve("../dist/manager.mjs")];
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
managerEntries,
|
||||||
|
previewAnnotations,
|
||||||
|
};
|
||||||
18
.storybook/main.ts
Normal file
18
.storybook/main.ts
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
import type { StorybookConfig } from "@storybook/react-vite";
|
||||||
|
const config: StorybookConfig = {
|
||||||
|
stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
|
||||||
|
addons: [
|
||||||
|
"@storybook/addon-links",
|
||||||
|
"@storybook/addon-essentials",
|
||||||
|
"@storybook/addon-interactions",
|
||||||
|
"./local-preset.js",
|
||||||
|
],
|
||||||
|
framework: {
|
||||||
|
name: "@storybook/react-vite",
|
||||||
|
options: {},
|
||||||
|
},
|
||||||
|
docs: {
|
||||||
|
autodocs: "tag",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
export default config;
|
||||||
3
.storybook/preview-head.html
Normal file
3
.storybook/preview-head.html
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
<script>
|
||||||
|
window.global = window;
|
||||||
|
</script>
|
||||||
18
.storybook/preview.ts
Normal file
18
.storybook/preview.ts
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
import type { Preview } from "@storybook/react";
|
||||||
|
|
||||||
|
const preview: Preview = {
|
||||||
|
parameters: {
|
||||||
|
backgrounds: {
|
||||||
|
default: "light",
|
||||||
|
},
|
||||||
|
actions: { argTypesRegex: "^on[A-Z].*" },
|
||||||
|
controls: {
|
||||||
|
matchers: {
|
||||||
|
color: /(background|color)$/i,
|
||||||
|
date: /Date$/,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default preview;
|
||||||
20
LICENSE
20
LICENSE
|
|
@ -1,9 +1,21 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2024 Valkyriecoms
|
Copyright (c) 2023 Storybook contributors
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
93
README.md
93
README.md
|
|
@ -1,3 +1,92 @@
|
||||||
# storybook-addon-valkyrie-theme
|
# Storybook Addon Valkyrie Theme
|
||||||
|
A Storybook addon for applying Valkyrie themes
|
||||||
|
|
||||||
A Storybook addon for applying Valkyrie themes
|
### Development scripts
|
||||||
|
|
||||||
|
- `yarn start` runs babel in watch mode and starts Storybook
|
||||||
|
- `yarn build` build and package your addon code
|
||||||
|
|
||||||
|
### Switch from TypeScript to JavaScript
|
||||||
|
|
||||||
|
Don't want to use TypeScript? We offer a handy eject command: `yarn eject-ts`
|
||||||
|
|
||||||
|
This will convert all code to JS. It is a destructive process, so we recommended running this before you start writing any code.
|
||||||
|
|
||||||
|
## What's included?
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The addon code lives in `src`. It demonstrates all core addon related concepts. The three [UI paradigms](https://storybook.js.org/docs/react/addons/addon-types#ui-based-addons)
|
||||||
|
|
||||||
|
- `src/Tool.tsx`
|
||||||
|
- `src/Panel.tsx`
|
||||||
|
- `src/Tab.tsx`
|
||||||
|
|
||||||
|
Which, along with the addon itself, are registered in `src/manager.ts`.
|
||||||
|
|
||||||
|
Managing State and interacting with a story:
|
||||||
|
|
||||||
|
- `src/withGlobals.ts` & `src/Tool.tsx` demonstrates how to use `useGlobals` to manage global state and modify the contents of a Story.
|
||||||
|
- `src/withRoundTrip.ts` & `src/Panel.tsx` demonstrates two-way communication using channels.
|
||||||
|
- `src/Tab.tsx` demonstrates how to use `useParameter` to access the current story's parameters.
|
||||||
|
|
||||||
|
Your addon might use one or more of these patterns. Feel free to delete unused code. Update `src/manager.ts` and `src/preview.ts` accordingly.
|
||||||
|
|
||||||
|
Lastly, configure you addon name in `src/constants.ts`.
|
||||||
|
|
||||||
|
### Metadata
|
||||||
|
|
||||||
|
Storybook addons are listed in the [catalog](https://storybook.js.org/addons) and distributed via npm. The catalog is populated by querying npm's registry for Storybook-specific metadata in `package.json`. This project has been configured with sample data. Learn more about available options in the [Addon metadata docs](https://storybook.js.org/docs/react/addons/addon-catalog#addon-metadata).
|
||||||
|
|
||||||
|
## Release Management
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
This project is configured to use [auto](https://github.com/intuit/auto) for release management. It generates a changelog and pushes it to both GitHub and npm. Therefore, you need to configure access to both:
|
||||||
|
|
||||||
|
- [`NPM_TOKEN`](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens) Create a token with both _Read and Publish_ permissions.
|
||||||
|
- [`GH_TOKEN`](https://github.com/settings/tokens) Create a token with the `repo` scope.
|
||||||
|
|
||||||
|
Then open your `package.json` and edit the following fields:
|
||||||
|
|
||||||
|
- `name`
|
||||||
|
- `author`
|
||||||
|
- `repository`
|
||||||
|
|
||||||
|
#### Local
|
||||||
|
|
||||||
|
To use `auto` locally create a `.env` file at the root of your project and add your tokens to it:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
GH_TOKEN=<value you just got from GitHub>
|
||||||
|
NPM_TOKEN=<value you just got from npm>
|
||||||
|
```
|
||||||
|
|
||||||
|
Lastly, **create labels on GitHub**. You’ll use these labels in the future when making changes to the package.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx auto create-labels
|
||||||
|
```
|
||||||
|
|
||||||
|
If you check on GitHub, you’ll now see a set of labels that `auto` would like you to use. Use these to tag future pull requests.
|
||||||
|
|
||||||
|
#### GitHub Actions
|
||||||
|
|
||||||
|
This template comes with GitHub actions already set up to publish your addon anytime someone pushes to your repository.
|
||||||
|
|
||||||
|
Go to `Settings > Secrets`, click `New repository secret`, and add your `NPM_TOKEN`.
|
||||||
|
|
||||||
|
### Creating a release
|
||||||
|
|
||||||
|
To create a release locally you can run the following command, otherwise the GitHub action will make the release for you.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
yarn release
|
||||||
|
```
|
||||||
|
|
||||||
|
That will:
|
||||||
|
|
||||||
|
- Build and package the addon code
|
||||||
|
- Bump the version
|
||||||
|
- Push a release to GitHub and npm
|
||||||
|
- Push a changelog to GitHub
|
||||||
1
manager.js
Normal file
1
manager.js
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
export * from "./dist/manager";
|
||||||
134
package.json
Normal file
134
package.json
Normal file
|
|
@ -0,0 +1,134 @@
|
||||||
|
{
|
||||||
|
"name": "storybook-addon-valkyrie-theme",
|
||||||
|
"version": "0.0.0",
|
||||||
|
"description": "A Storybook addon for applying Valkyrie themes",
|
||||||
|
"keywords": [
|
||||||
|
"storybook-addons",
|
||||||
|
"storybook-addons"
|
||||||
|
],
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://toastielab.dev/Valkyriecoms/storybook-addon-valkyrie-theme.git"
|
||||||
|
},
|
||||||
|
"author": "Toastie <toastie@toastiet0ast.com>",
|
||||||
|
"license": "MIT",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"require": "./dist/index.js",
|
||||||
|
"import": "./dist/index.mjs",
|
||||||
|
"types": "./dist/index.d.ts"
|
||||||
|
},
|
||||||
|
"./manager": {
|
||||||
|
"require": "./dist/manager.js",
|
||||||
|
"import": "./dist/manager.mjs",
|
||||||
|
"types": "./dist/manager.d.ts"
|
||||||
|
},
|
||||||
|
"./manager.js": {
|
||||||
|
"require": "./dist/manager.js",
|
||||||
|
"import": "./dist/manager.mjs",
|
||||||
|
"types": "./dist/manager.d.ts"
|
||||||
|
},
|
||||||
|
"./preview": {
|
||||||
|
"require": "./dist/preview.js",
|
||||||
|
"import": "./dist/preview.mjs",
|
||||||
|
"types": "./dist/preview.d.ts"
|
||||||
|
},
|
||||||
|
"./preview.js": {
|
||||||
|
"require": "./dist/preview.js",
|
||||||
|
"import": "./dist/preview.mjs",
|
||||||
|
"types": "./dist/preview.d.ts"
|
||||||
|
},
|
||||||
|
"./package.json": "./package.json"
|
||||||
|
},
|
||||||
|
"main": "dist/index.js",
|
||||||
|
"module": "dist/index.mjs",
|
||||||
|
"types": "dist/index.d.ts",
|
||||||
|
"files": [
|
||||||
|
"dist/**/*",
|
||||||
|
"README.md",
|
||||||
|
"*.js",
|
||||||
|
"*.d.ts"
|
||||||
|
],
|
||||||
|
"scripts": {
|
||||||
|
"clean": "rimraf ./dist",
|
||||||
|
"prebuild": "yarn clean",
|
||||||
|
"build": "tsup",
|
||||||
|
"build:watch": "yarn build --watch",
|
||||||
|
"test": "echo \"Error: no test specified\" && exit 1",
|
||||||
|
"start": "concurrently \"yarn build:watch\" \"yarn storybook --quiet --no-open\"",
|
||||||
|
"prerelease": "zx scripts/prepublish-checks.mjs",
|
||||||
|
"release": "yarn build && auto shipit",
|
||||||
|
"eject-ts": "zx scripts/eject-typescript.mjs",
|
||||||
|
"storybook": "storybook dev -p 6006",
|
||||||
|
"build-storybook": "storybook build"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@storybook/addon-essentials": "^7.0.0-rc.4",
|
||||||
|
"@storybook/addon-interactions": "^7.0.0-rc.4",
|
||||||
|
"@storybook/addon-links": "^7.0.0-rc.4",
|
||||||
|
"@storybook/blocks": "^7.0.0-rc.4",
|
||||||
|
"@storybook/components": "^7.0.0-rc.4",
|
||||||
|
"@storybook/core-events": "^7.0.0-rc.4",
|
||||||
|
"@storybook/manager-api": "^7.0.0-rc.4",
|
||||||
|
"@storybook/preview-api": "^7.0.0-rc.4",
|
||||||
|
"@storybook/react": "^7.0.0-rc.4",
|
||||||
|
"@storybook/react-vite": "^7.0.0-rc.4",
|
||||||
|
"@storybook/testing-library": "^0.0.14-next.1",
|
||||||
|
"@storybook/theming": "^7.0.0-rc.4",
|
||||||
|
"@storybook/types": "^7.0.0-rc.4",
|
||||||
|
"@types/node": "^18.15.0",
|
||||||
|
"@vitejs/plugin-react": "^3.1.0",
|
||||||
|
"auto": "^10.3.0",
|
||||||
|
"boxen": "^5.0.1",
|
||||||
|
"concurrently": "^6.2.0",
|
||||||
|
"dedent": "^0.7.0",
|
||||||
|
"prettier": "^2.3.1",
|
||||||
|
"prompts": "^2.4.2",
|
||||||
|
"prop-types": "^15.8.1",
|
||||||
|
"react": "^18.0.0",
|
||||||
|
"react-dom": "^18.0.0",
|
||||||
|
"rimraf": "^3.0.2",
|
||||||
|
"storybook": "^7.0.0-rc.4",
|
||||||
|
"tsup": "^6.6.3",
|
||||||
|
"typescript": "^4.9.5",
|
||||||
|
"vite": "^4.1.4",
|
||||||
|
"zx": "^1.14.1"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@storybook/blocks": "^7.0.0-rc.4",
|
||||||
|
"@storybook/components": "^7.0.0-rc.4",
|
||||||
|
"@storybook/core-events": "^7.0.0-rc.4",
|
||||||
|
"@storybook/manager-api": "^7.0.0-rc.4",
|
||||||
|
"@storybook/preview-api": "^7.0.0-rc.4",
|
||||||
|
"@storybook/theming": "^7.0.0-rc.4",
|
||||||
|
"@storybook/types": "^7.0.0-rc.4",
|
||||||
|
"react": "^16.8.0 || ^17.0.0 || ^18.0.0",
|
||||||
|
"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
|
||||||
|
},
|
||||||
|
"peerDependenciesMeta": {
|
||||||
|
"react": {
|
||||||
|
"optional": true
|
||||||
|
},
|
||||||
|
"react-dom": {
|
||||||
|
"optional": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
},
|
||||||
|
"storybook": {
|
||||||
|
"displayName": "Valkyrie Theme",
|
||||||
|
"supportedFrameworks": [
|
||||||
|
"react",
|
||||||
|
"vue",
|
||||||
|
"angular",
|
||||||
|
"web-components",
|
||||||
|
"ember",
|
||||||
|
"html",
|
||||||
|
"svelte",
|
||||||
|
"preact"
|
||||||
|
],
|
||||||
|
"icon": "https://user-images.githubusercontent.com/321738/63501763-88dbf600-c4cc-11e9-96cd-94adadc2fd72.png"
|
||||||
|
},
|
||||||
|
"packageManager": "yarn@1.22.19"
|
||||||
|
}
|
||||||
1
preview.js
Normal file
1
preview.js
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
export * from "./dist/preview";
|
||||||
30
scripts/eject-typescript.mjs
Normal file
30
scripts/eject-typescript.mjs
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
#!/usr/bin/env zx
|
||||||
|
|
||||||
|
// Copy TS files and delete src
|
||||||
|
await $`cp -r ./src ./srcTS`;
|
||||||
|
await $`rm -rf ./src`;
|
||||||
|
await $`mkdir ./src`;
|
||||||
|
|
||||||
|
// Convert TS code to JS
|
||||||
|
await $`babel --no-babelrc --presets @babel/preset-typescript ./srcTS -d ./src --extensions \".js,.jsx,.ts,.tsx\" --ignore "./srcTS/typings.d.ts"`;
|
||||||
|
|
||||||
|
// Format the newly created .js files
|
||||||
|
await $`prettier --write ./src`;
|
||||||
|
|
||||||
|
// Add in minimal files required for the TS build setup
|
||||||
|
await $`touch ./src/dummy.ts`;
|
||||||
|
await $`printf "export {};" >> ./src/dummy.ts`;
|
||||||
|
|
||||||
|
await $`touch ./src/typings.d.ts`;
|
||||||
|
await $`printf 'declare module "global";' >> ./src/typings.d.ts`;
|
||||||
|
|
||||||
|
// Clean up
|
||||||
|
await $`rm -rf ./srcTS`;
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
chalk.green.bold`
|
||||||
|
TypeScript Ejection complete!`,
|
||||||
|
chalk.green`
|
||||||
|
Addon code converted with JS. The TypeScript build setup is still available in case you want to adopt TypeScript in the future.
|
||||||
|
`
|
||||||
|
);
|
||||||
56
scripts/prepublish-checks.mjs
Normal file
56
scripts/prepublish-checks.mjs
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
#!/usr/bin/env zx
|
||||||
|
|
||||||
|
const packageJson = require("../package.json");
|
||||||
|
const boxen = require("boxen");
|
||||||
|
const dedent = require("dedent");
|
||||||
|
|
||||||
|
const name = packageJson.name;
|
||||||
|
const displayName = packageJson.storybook.displayName;
|
||||||
|
|
||||||
|
let exitCode = 0;
|
||||||
|
$.verbose = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check that meta data has been updated
|
||||||
|
*/
|
||||||
|
if (name.includes("addon-kit") || displayName.includes("Addon Kit")) {
|
||||||
|
console.error(
|
||||||
|
boxen(
|
||||||
|
dedent`
|
||||||
|
${chalk.red.bold("Missing metadata")}
|
||||||
|
|
||||||
|
${chalk.red(dedent`Your package name and/or displayName includes default values from the Addon Kit.
|
||||||
|
The addon gallery filters out all such addons.
|
||||||
|
|
||||||
|
Please configure appropriate metadata before publishing your addon. For more info, see:
|
||||||
|
https://storybook.js.org/docs/react/addons/addon-catalog#addon-metadata`)}`,
|
||||||
|
{ padding: 1, borderColor: "red" }
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
exitCode = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check that README has been updated
|
||||||
|
*/
|
||||||
|
const readmeTestStrings =
|
||||||
|
"# Storybook Addon Kit|Click the \\*\\*Use this template\\*\\* button to get started.|https://user-images.githubusercontent.com/42671/106809879-35b32000-663a-11eb-9cdc-89f178b5273f.gif";
|
||||||
|
|
||||||
|
if ((await $`cat README.md | grep -E ${readmeTestStrings}`.exitCode) == 0) {
|
||||||
|
console.error(
|
||||||
|
boxen(
|
||||||
|
dedent`
|
||||||
|
${chalk.red.bold("README not updated")}
|
||||||
|
|
||||||
|
${chalk.red(dedent`You are using the default README.md file that comes with the addon kit.
|
||||||
|
Please update it to provide info on what your addon does and how to use it.`)}
|
||||||
|
`,
|
||||||
|
{ padding: 1, borderColor: "red" }
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
exitCode = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
process.exit(exitCode);
|
||||||
180
scripts/welcome.js
Normal file
180
scripts/welcome.js
Normal file
|
|
@ -0,0 +1,180 @@
|
||||||
|
/* eslint-disable eslint-comments/disable-enable-pair */
|
||||||
|
/* eslint-disable no-console */
|
||||||
|
const prompts = require("prompts");
|
||||||
|
const dedent = require("ts-dedent").default;
|
||||||
|
const path = require("path");
|
||||||
|
const fs = require("fs");
|
||||||
|
const { execSync } = require("child_process");
|
||||||
|
|
||||||
|
// CLI questions
|
||||||
|
const questions = [
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "authorName",
|
||||||
|
initial: "",
|
||||||
|
message: "What is the package author name?*",
|
||||||
|
validate: (name) => (name === "" ? "Name can't be empty" : true),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "authorEmail",
|
||||||
|
initial: "",
|
||||||
|
message: "What is the package author email?",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "packageName",
|
||||||
|
message: "What is the addon package name (eg: storybook-addon-something)?*",
|
||||||
|
validate: (name) => (name === "" ? "Package name can't be empty" : true),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "displayName",
|
||||||
|
message:
|
||||||
|
"What is the addon display name (this will be used in the addon catalog)?*",
|
||||||
|
validate: (name) =>
|
||||||
|
name === ""
|
||||||
|
? "Display name can't be empty. For more info, see: https://storybook.js.org/docs/react/addons/addon-catalog#addon-metadata"
|
||||||
|
: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "addonDescription",
|
||||||
|
initial: "",
|
||||||
|
message: "Write a short description of the addon*",
|
||||||
|
validate: (name) => (name === "" ? "Description can't be empty" : true),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "repoUrl",
|
||||||
|
message: "Git repo URL for your addon package (https://github.com/...)*",
|
||||||
|
validate: (url) => (url === "" ? "URL can't be empty" : true),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
name: "addonIcon",
|
||||||
|
initial:
|
||||||
|
"https://user-images.githubusercontent.com/321738/63501763-88dbf600-c4cc-11e9-96cd-94adadc2fd72.png",
|
||||||
|
message: "URL of your addon icon",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "list",
|
||||||
|
name: "keywords",
|
||||||
|
initial: "storybook-addons",
|
||||||
|
message: "Enter addon keywords (comma separated)",
|
||||||
|
separator: ",",
|
||||||
|
format: (keywords) =>
|
||||||
|
keywords
|
||||||
|
.concat(["storybook-addons"])
|
||||||
|
.map((k) => `"${k}"`)
|
||||||
|
.join(", "),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: "list",
|
||||||
|
name: "supportedFrameworks",
|
||||||
|
initial:
|
||||||
|
"react, vue, angular, web-components, ember, html, svelte, preact, react-native",
|
||||||
|
message: "List of frameworks you support (comma separated)?",
|
||||||
|
separator: ",",
|
||||||
|
format: (frameworks) => frameworks.map((k) => `"${k}"`).join(", "),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const REPLACE_TEMPLATES = {
|
||||||
|
packageName: "storybook-addon-kit",
|
||||||
|
addonDescription: "everything you need to build a Storybook addon",
|
||||||
|
packageAuthor: "package-author",
|
||||||
|
repoUrl: "https://github.com/storybookjs/storybook-addon-kit",
|
||||||
|
keywords: `"storybook-addons"`,
|
||||||
|
displayName: "Addon Kit",
|
||||||
|
supportedFrameworks: `"supported-frameworks"`,
|
||||||
|
};
|
||||||
|
|
||||||
|
const bold = (message) => `\u001b[1m${message}\u001b[22m`;
|
||||||
|
const magenta = (message) => `\u001b[35m${message}\u001b[39m`;
|
||||||
|
const blue = (message) => `\u001b[34m${message}\u001b[39m`;
|
||||||
|
|
||||||
|
const main = async () => {
|
||||||
|
console.log(
|
||||||
|
bold(
|
||||||
|
magenta(
|
||||||
|
dedent`
|
||||||
|
Welcome to Storybook addon-kit!
|
||||||
|
Please answer the following questions while we prepare this project for you:\n
|
||||||
|
`
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
const {
|
||||||
|
authorName,
|
||||||
|
authorEmail,
|
||||||
|
packageName,
|
||||||
|
addonDescription,
|
||||||
|
repoUrl,
|
||||||
|
displayName,
|
||||||
|
keywords,
|
||||||
|
supportedFrameworks,
|
||||||
|
} = await prompts(questions);
|
||||||
|
|
||||||
|
if (!authorName || !packageName) {
|
||||||
|
console.log(
|
||||||
|
`\nProcess canceled by the user. Feel free to run ${bold(
|
||||||
|
"yarn postinstall"
|
||||||
|
)} to execute the installation steps again!`
|
||||||
|
);
|
||||||
|
process.exit(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
const authorField = authorName + (authorEmail ? ` <${authorEmail}>` : "");
|
||||||
|
|
||||||
|
const packageJson = path.resolve(__dirname, `../package.json`);
|
||||||
|
|
||||||
|
console.log(`\n👷 Updating package.json...`);
|
||||||
|
let packageJsonContents = fs.readFileSync(packageJson, "utf-8");
|
||||||
|
|
||||||
|
packageJsonContents = packageJsonContents
|
||||||
|
.replace(REPLACE_TEMPLATES.packageName, packageName)
|
||||||
|
.replace(REPLACE_TEMPLATES.addonDescription, addonDescription)
|
||||||
|
.replace(REPLACE_TEMPLATES.packageAuthor, authorField)
|
||||||
|
.replace(REPLACE_TEMPLATES.keywords, keywords)
|
||||||
|
.replace(REPLACE_TEMPLATES.repoUrl, repoUrl)
|
||||||
|
.replace(REPLACE_TEMPLATES.displayName, displayName)
|
||||||
|
.replace(REPLACE_TEMPLATES.supportedFrameworks, supportedFrameworks)
|
||||||
|
.replace(/\s*"postinstall".*node.*scripts\/welcome.js.*",/, '');
|
||||||
|
|
||||||
|
fs.writeFileSync(packageJson, packageJsonContents);
|
||||||
|
|
||||||
|
console.log("📝 Updating the README...");
|
||||||
|
const readme = path.resolve(__dirname, `../README.md`);
|
||||||
|
let readmeContents = fs.readFileSync(readme, "utf-8");
|
||||||
|
|
||||||
|
const regex = /<\!-- README START -->([\s\S]*)<\!-- README END -->/g;
|
||||||
|
|
||||||
|
readmeContents = readmeContents.replace(
|
||||||
|
regex,
|
||||||
|
dedent`
|
||||||
|
# Storybook Addon ${displayName}
|
||||||
|
${addonDescription}
|
||||||
|
`
|
||||||
|
);
|
||||||
|
|
||||||
|
fs.writeFileSync(readme, readmeContents);
|
||||||
|
|
||||||
|
console.log(`📦 Creating a commit...`);
|
||||||
|
execSync('git add . && git commit -m "project setup" --no-verify');
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
dedent`\n
|
||||||
|
🚀 All done! Run \`yarn start\` to get started.
|
||||||
|
|
||||||
|
Thanks for using this template, ${authorName.split(" ")[0]}! ❤️
|
||||||
|
|
||||||
|
Feel free to open issues in case there are bugs/feature requests at:
|
||||||
|
|
||||||
|
${bold(blue("https://github.com/storybookjs/addon-kit"))}\n
|
||||||
|
`
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
main().catch((e) => console.log(`Something went wrong: ${e}`));
|
||||||
67
src/Tool.tsx
Normal file
67
src/Tool.tsx
Normal file
|
|
@ -0,0 +1,67 @@
|
||||||
|
import React, { memo, useState } from "react";
|
||||||
|
import { useGlobals, useStorybookApi } from "@storybook/manager-api";
|
||||||
|
import { Icons, IconButton, TooltipLinkList, WithTooltip } from "@storybook/components";
|
||||||
|
import { ADDON_ID, PARAM_KEY, TOOL_ID } from "./constants";
|
||||||
|
|
||||||
|
export const Tool = memo(function MyAddonSelector() {
|
||||||
|
const [isTooltipVisible, setIsTooltipVisible] = useState(false);
|
||||||
|
const [globals, updateGlobals] = useGlobals();
|
||||||
|
const api = useStorybookApi();
|
||||||
|
|
||||||
|
const isActive = !!globals[PARAM_KEY];
|
||||||
|
|
||||||
|
return (
|
||||||
|
<WithTooltip
|
||||||
|
placement="top"
|
||||||
|
closeOnOutsideClick
|
||||||
|
tooltip={({ onHide }) => {
|
||||||
|
return (
|
||||||
|
<TooltipLinkList
|
||||||
|
links={[
|
||||||
|
'(clear)',
|
||||||
|
'l-light',
|
||||||
|
'l-coffee',
|
||||||
|
'l-apricot',
|
||||||
|
'l-rainy',
|
||||||
|
'l-botanical',
|
||||||
|
'l-vivid',
|
||||||
|
'l-cherry',
|
||||||
|
'l-sushi',
|
||||||
|
'l-u0',
|
||||||
|
'd-dark',
|
||||||
|
'd-persimmon',
|
||||||
|
'd-astro',
|
||||||
|
'd-future',
|
||||||
|
'd-botanical',
|
||||||
|
'd-green-lime',
|
||||||
|
'd-green-orange',
|
||||||
|
'd-cherry',
|
||||||
|
'd-ice',
|
||||||
|
'd-u0',
|
||||||
|
].map((theme, i) => ({
|
||||||
|
id: theme,
|
||||||
|
title: theme,
|
||||||
|
onClick() {
|
||||||
|
updateGlobals({
|
||||||
|
[PARAM_KEY]: i ? theme : false,
|
||||||
|
});
|
||||||
|
onHide();
|
||||||
|
},
|
||||||
|
value: theme,
|
||||||
|
active: theme === globals[PARAM_KEY],
|
||||||
|
}))}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}}
|
||||||
|
onVisibleChange={setIsTooltipVisible}
|
||||||
|
>
|
||||||
|
<IconButton
|
||||||
|
key={TOOL_ID}
|
||||||
|
active={isActive || isTooltipVisible}
|
||||||
|
title="Switch theme"
|
||||||
|
>
|
||||||
|
<Icons icon="mirror" />
|
||||||
|
</IconButton>
|
||||||
|
</WithTooltip>
|
||||||
|
);
|
||||||
|
});
|
||||||
95
src/components/List.tsx
Normal file
95
src/components/List.tsx
Normal file
|
|
@ -0,0 +1,95 @@
|
||||||
|
import React, { Fragment, useState } from "react";
|
||||||
|
import { styled, themes, convert } from "@storybook/theming";
|
||||||
|
import { Icons, IconsProps } from "@storybook/components";
|
||||||
|
|
||||||
|
const ListWrapper = styled.ul({
|
||||||
|
listStyle: "none",
|
||||||
|
fontSize: 14,
|
||||||
|
padding: 0,
|
||||||
|
margin: 0,
|
||||||
|
});
|
||||||
|
|
||||||
|
const Wrapper = styled.div({
|
||||||
|
display: "flex",
|
||||||
|
width: "100%",
|
||||||
|
borderBottom: `1px solid ${convert(themes.normal).appBorderColor}`,
|
||||||
|
"&:hover": {
|
||||||
|
background: convert(themes.normal).background.hoverable,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const Icon = styled(Icons)<IconsProps>({
|
||||||
|
height: 10,
|
||||||
|
width: 10,
|
||||||
|
minWidth: 10,
|
||||||
|
color: convert(themes.normal).color.mediumdark,
|
||||||
|
marginRight: 10,
|
||||||
|
transition: "transform 0.1s ease-in-out",
|
||||||
|
alignSelf: "center",
|
||||||
|
display: "inline-flex",
|
||||||
|
});
|
||||||
|
|
||||||
|
const HeaderBar = styled.div({
|
||||||
|
padding: convert(themes.normal).layoutMargin,
|
||||||
|
paddingLeft: convert(themes.normal).layoutMargin - 3,
|
||||||
|
background: "none",
|
||||||
|
color: "inherit",
|
||||||
|
textAlign: "left",
|
||||||
|
cursor: "pointer",
|
||||||
|
borderLeft: "3px solid transparent",
|
||||||
|
width: "100%",
|
||||||
|
|
||||||
|
"&:focus": {
|
||||||
|
outline: "0 none",
|
||||||
|
borderLeft: `3px solid ${convert(themes.normal).color.secondary}`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const Description = styled.div({
|
||||||
|
padding: convert(themes.normal).layoutMargin,
|
||||||
|
marginBottom: convert(themes.normal).layoutMargin,
|
||||||
|
fontStyle: "italic",
|
||||||
|
});
|
||||||
|
|
||||||
|
type Item = {
|
||||||
|
title: string;
|
||||||
|
description: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
interface ListItemProps {
|
||||||
|
item: Item;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ListItem: React.FC<ListItemProps> = ({ item }) => {
|
||||||
|
const [open, onToggle] = useState(false);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Fragment>
|
||||||
|
<Wrapper>
|
||||||
|
<HeaderBar onClick={() => onToggle(!open)} role="button">
|
||||||
|
<Icon
|
||||||
|
icon="arrowdown"
|
||||||
|
color={convert(themes.normal).appBorderColor}
|
||||||
|
style={{
|
||||||
|
transform: `rotate(${open ? 0 : -90}deg)`,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
{item.title}
|
||||||
|
</HeaderBar>
|
||||||
|
</Wrapper>
|
||||||
|
{open ? <Description>{item.description}</Description> : null}
|
||||||
|
</Fragment>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
interface ListProps {
|
||||||
|
items: Item[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export const List: React.FC<ListProps> = ({ items }) => (
|
||||||
|
<ListWrapper>
|
||||||
|
{items.map((item, idx) => (
|
||||||
|
<ListItem key={idx} item={item}></ListItem>
|
||||||
|
))}
|
||||||
|
</ListWrapper>
|
||||||
|
);
|
||||||
9
src/constants.ts
Normal file
9
src/constants.ts
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
export const ADDON_ID = "valkyriecoms/storybook-addon-valkyrie-theme";
|
||||||
|
export const TOOL_ID = `${ADDON_ID}/tool`;
|
||||||
|
export const PARAM_KEY = `valkyrieTheme`;
|
||||||
|
|
||||||
|
export const EVENTS = {
|
||||||
|
RESULT: `${ADDON_ID}/result`,
|
||||||
|
REQUEST: `${ADDON_ID}/request`,
|
||||||
|
CLEAR: `${ADDON_ID}/clear`,
|
||||||
|
};
|
||||||
2
src/index.ts
Normal file
2
src/index.ts
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
// make it work with --isolatedModules
|
||||||
|
export default {};
|
||||||
19
src/manager.ts
Normal file
19
src/manager.ts
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
import { addons, types } from "@storybook/manager-api";
|
||||||
|
import { ADDON_ID, TOOL_ID } from "./constants";
|
||||||
|
import { Tool } from "./Tool";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Note: if you want to use JSX in this file, rename it to `manager.tsx`
|
||||||
|
* and update the entry prop in tsup.config.ts to use "src/manager.tsx",
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Register the addon
|
||||||
|
addons.register(ADDON_ID, () => {
|
||||||
|
// Register the tool
|
||||||
|
addons.add(TOOL_ID, {
|
||||||
|
type: types.TOOL,
|
||||||
|
title: "Valkyrie theme",
|
||||||
|
match: ({ viewMode }) => !!(viewMode && viewMode.match(/^(story|docs)$/)),
|
||||||
|
render: Tool,
|
||||||
|
});
|
||||||
|
});
|
||||||
27
src/preview.ts
Normal file
27
src/preview.ts
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
/**
|
||||||
|
* A decorator is a way to wrap a story in extra “rendering” functionality. Many addons define decorators
|
||||||
|
* in order to augment stories:
|
||||||
|
* - with extra rendering
|
||||||
|
* - gather details about how a story is rendered
|
||||||
|
*
|
||||||
|
* When writing stories, decorators are typically used to wrap stories with extra markup or context mocking.
|
||||||
|
*
|
||||||
|
* https://storybook.js.org/docs/react/writing-stories/decorators
|
||||||
|
*/
|
||||||
|
import type { Renderer, ProjectAnnotations } from "@storybook/types";
|
||||||
|
import { PARAM_KEY } from "./constants";
|
||||||
|
import { withGlobals } from "./withGlobals";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Note: if you want to use JSX in this file, rename it to `preview.tsx`
|
||||||
|
* and update the entry prop in tsup.config.ts to use "src/preview.tsx",
|
||||||
|
*/
|
||||||
|
|
||||||
|
const preview: ProjectAnnotations<Renderer> = {
|
||||||
|
decorators: [withGlobals],
|
||||||
|
globals: {
|
||||||
|
[PARAM_KEY]: false,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default preview;
|
||||||
53
src/stories/Button.stories.ts
Normal file
53
src/stories/Button.stories.ts
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
import type { Meta, StoryObj } from "@storybook/react";
|
||||||
|
|
||||||
|
import { Button } from "./Button";
|
||||||
|
|
||||||
|
// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
|
||||||
|
const meta: Meta<typeof Button> = {
|
||||||
|
title: "Example/Button",
|
||||||
|
component: Button,
|
||||||
|
// More on argTypes: https://storybook.js.org/docs/react/api/argtypes
|
||||||
|
argTypes: {
|
||||||
|
backgroundColor: { control: "color" },
|
||||||
|
},
|
||||||
|
tags: ["autodocs"],
|
||||||
|
parameters: {
|
||||||
|
myAddonParameter: `
|
||||||
|
<MyComponent boolProp scalarProp={1} complexProp={{ foo: 1, bar: '2' }}>
|
||||||
|
<SomeOtherComponent funcProp={(a) => a.id} />
|
||||||
|
</MyComponent>
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof Button>;
|
||||||
|
|
||||||
|
// More on component templates: https://storybook.js.org/docs/react/writing-stories/introduction#using-args
|
||||||
|
export const Primary: Story = {
|
||||||
|
// More on args: https://storybook.js.org/docs/react/writing-stories/args
|
||||||
|
args: {
|
||||||
|
primary: true,
|
||||||
|
label: "Button",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Secondary: Story = {
|
||||||
|
args: {
|
||||||
|
label: "Button",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Large: Story = {
|
||||||
|
args: {
|
||||||
|
size: "large",
|
||||||
|
label: "Button",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Small: Story = {
|
||||||
|
args: {
|
||||||
|
size: "small",
|
||||||
|
label: "Button",
|
||||||
|
},
|
||||||
|
};
|
||||||
48
src/stories/Button.tsx
Normal file
48
src/stories/Button.tsx
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
import React from 'react';
|
||||||
|
import './button.css';
|
||||||
|
|
||||||
|
interface ButtonProps {
|
||||||
|
/**
|
||||||
|
* Is this the principal call to action on the page?
|
||||||
|
*/
|
||||||
|
primary?: boolean;
|
||||||
|
/**
|
||||||
|
* What background color to use
|
||||||
|
*/
|
||||||
|
backgroundColor?: string;
|
||||||
|
/**
|
||||||
|
* How large should the button be?
|
||||||
|
*/
|
||||||
|
size?: 'small' | 'medium' | 'large';
|
||||||
|
/**
|
||||||
|
* Button contents
|
||||||
|
*/
|
||||||
|
label: string;
|
||||||
|
/**
|
||||||
|
* Optional click handler
|
||||||
|
*/
|
||||||
|
onClick?: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Primary UI component for user interaction
|
||||||
|
*/
|
||||||
|
export const Button = ({
|
||||||
|
primary = false,
|
||||||
|
size = 'medium',
|
||||||
|
backgroundColor,
|
||||||
|
label,
|
||||||
|
...props
|
||||||
|
}: ButtonProps) => {
|
||||||
|
const mode = primary ? 'storybook-button--primary' : 'storybook-button--secondary';
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={['storybook-button', `storybook-button--${size}`, mode].join(' ')}
|
||||||
|
style={{ backgroundColor }}
|
||||||
|
{...props}
|
||||||
|
>
|
||||||
|
{label}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
};
|
||||||
56
src/stories/Header.tsx
Normal file
56
src/stories/Header.tsx
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
import React from 'react';
|
||||||
|
|
||||||
|
import { Button } from './Button';
|
||||||
|
import './header.css';
|
||||||
|
|
||||||
|
type User = {
|
||||||
|
name: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
interface HeaderProps {
|
||||||
|
user?: User;
|
||||||
|
onLogin: () => void;
|
||||||
|
onLogout: () => void;
|
||||||
|
onCreateAccount: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const Header = ({ user, onLogin, onLogout, onCreateAccount }: HeaderProps) => (
|
||||||
|
<header>
|
||||||
|
<div className="wrapper">
|
||||||
|
<div>
|
||||||
|
<svg width="32" height="32" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<g fill="none" fillRule="evenodd">
|
||||||
|
<path
|
||||||
|
d="M10 0h12a10 10 0 0110 10v12a10 10 0 01-10 10H10A10 10 0 010 22V10A10 10 0 0110 0z"
|
||||||
|
fill="#FFF"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M5.3 10.6l10.4 6v11.1l-10.4-6v-11zm11.4-6.2l9.7 5.5-9.7 5.6V4.4z"
|
||||||
|
fill="#555AB9"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M27.2 10.6v11.2l-10.5 6V16.5l10.5-6zM15.7 4.4v11L6 10l9.7-5.5z"
|
||||||
|
fill="#91BAF8"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
<h1>Acme</h1>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
{user ? (
|
||||||
|
<>
|
||||||
|
<span className="welcome">
|
||||||
|
Welcome, <b>{user.name}</b>!
|
||||||
|
</span>
|
||||||
|
<Button size="small" onClick={onLogout} label="Log out" />
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
<>
|
||||||
|
<Button size="small" onClick={onLogin} label="Log in" />
|
||||||
|
<Button primary size="small" onClick={onCreateAccount} label="Sign up" />
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
);
|
||||||
211
src/stories/Introduction.mdx
Normal file
211
src/stories/Introduction.mdx
Normal file
|
|
@ -0,0 +1,211 @@
|
||||||
|
import { Meta } from '@storybook/blocks';
|
||||||
|
import Code from './assets/code-brackets.svg';
|
||||||
|
import Colors from './assets/colors.svg';
|
||||||
|
import Comments from './assets/comments.svg';
|
||||||
|
import Direction from './assets/direction.svg';
|
||||||
|
import Flow from './assets/flow.svg';
|
||||||
|
import Plugin from './assets/plugin.svg';
|
||||||
|
import Repo from './assets/repo.svg';
|
||||||
|
import StackAlt from './assets/stackalt.svg';
|
||||||
|
|
||||||
|
<Meta title="Example/Introduction" />
|
||||||
|
|
||||||
|
<style>
|
||||||
|
{`
|
||||||
|
.subheading {
|
||||||
|
--mediumdark: '#999999';
|
||||||
|
font-weight: 700;
|
||||||
|
font-size: 13px;
|
||||||
|
color: #999;
|
||||||
|
letter-spacing: 6px;
|
||||||
|
line-height: 24px;
|
||||||
|
text-transform: uppercase;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
margin-top: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-list {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
grid-template-rows: 1fr 1fr;
|
||||||
|
row-gap: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 620px) {
|
||||||
|
.link-list {
|
||||||
|
row-gap: 20px;
|
||||||
|
column-gap: 20px;
|
||||||
|
grid-template-columns: 1fr 1fr;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media all and (-ms-high-contrast:none) {
|
||||||
|
.link-list {
|
||||||
|
display: -ms-grid;
|
||||||
|
-ms-grid-columns: 1fr 1fr;
|
||||||
|
-ms-grid-rows: 1fr 1fr;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-item {
|
||||||
|
display: block;
|
||||||
|
padding: 20px 30px 20px 15px;
|
||||||
|
border: 1px solid #00000010;
|
||||||
|
border-radius: 5px;
|
||||||
|
transition: background 150ms ease-out, border 150ms ease-out, transform 150ms ease-out;
|
||||||
|
color: #333333;
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-start;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-item:hover {
|
||||||
|
border-color: #1EA7FD50;
|
||||||
|
transform: translate3d(0, -3px, 0);
|
||||||
|
box-shadow: rgba(0, 0, 0, 0.08) 0 3px 10px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-item:active {
|
||||||
|
border-color: #1EA7FD;
|
||||||
|
transform: translate3d(0, 0, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-item strong {
|
||||||
|
font-weight: 700;
|
||||||
|
display: block;
|
||||||
|
margin-bottom: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-item img {
|
||||||
|
height: 40px;
|
||||||
|
width: 40px;
|
||||||
|
margin-right: 15px;
|
||||||
|
flex: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.link-item span {
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tip {
|
||||||
|
display: inline-block;
|
||||||
|
border-radius: 1em;
|
||||||
|
font-size: 11px;
|
||||||
|
line-height: 12px;
|
||||||
|
font-weight: 700;
|
||||||
|
background: #E7FDD8;
|
||||||
|
color: #66BF3C;
|
||||||
|
padding: 4px 12px;
|
||||||
|
margin-right: 10px;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tip-wrapper {
|
||||||
|
font-size: 13px;
|
||||||
|
line-height: 20px;
|
||||||
|
margin-top: 40px;
|
||||||
|
margin-bottom: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tip-wrapper code {
|
||||||
|
font-size: 12px;
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
`}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
# Welcome to Storybook
|
||||||
|
|
||||||
|
Storybook helps you build UI components in isolation from your app's business logic, data, and context.
|
||||||
|
That makes it easy to develop hard-to-reach states. Save these UI states as **stories** to revisit during development, testing, or QA.
|
||||||
|
|
||||||
|
Browse example stories now by navigating to them in the sidebar.
|
||||||
|
View their code in the `stories` directory to learn how they work.
|
||||||
|
We recommend building UIs with a [**component-driven**](https://componentdriven.org) process starting with atomic components and ending with pages.
|
||||||
|
|
||||||
|
<div className="subheading">Configure</div>
|
||||||
|
|
||||||
|
<div className="link-list">
|
||||||
|
<a
|
||||||
|
className="link-item"
|
||||||
|
href="https://storybook.js.org/docs/react/addons/addon-types"
|
||||||
|
target="_blank"
|
||||||
|
>
|
||||||
|
<img src={Plugin} alt="plugin" />
|
||||||
|
<span>
|
||||||
|
<strong>Presets for popular tools</strong>
|
||||||
|
Easy setup for TypeScript, SCSS and more.
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
className="link-item"
|
||||||
|
href="https://storybook.js.org/docs/react/configure/webpack"
|
||||||
|
target="_blank"
|
||||||
|
>
|
||||||
|
<img src={StackAlt} alt="Build" />
|
||||||
|
<span>
|
||||||
|
<strong>Build configuration</strong>
|
||||||
|
How to customize webpack and Babel
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
className="link-item"
|
||||||
|
href="https://storybook.js.org/docs/react/configure/styling-and-css"
|
||||||
|
target="_blank"
|
||||||
|
>
|
||||||
|
<img src={Colors} alt="colors" />
|
||||||
|
<span>
|
||||||
|
<strong>Styling</strong>
|
||||||
|
How to load and configure CSS libraries
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
className="link-item"
|
||||||
|
href="https://storybook.js.org/docs/react/get-started/setup#configure-storybook-for-your-stack"
|
||||||
|
target="_blank"
|
||||||
|
>
|
||||||
|
<img src={Flow} alt="flow" />
|
||||||
|
<span>
|
||||||
|
<strong>Data</strong>
|
||||||
|
Providers and mocking for data libraries
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="subheading">Learn</div>
|
||||||
|
|
||||||
|
<div className="link-list">
|
||||||
|
<a className="link-item" href="https://storybook.js.org/docs" target="_blank">
|
||||||
|
<img src={Repo} alt="repo" />
|
||||||
|
<span>
|
||||||
|
<strong>Storybook documentation</strong>
|
||||||
|
Configure, customize, and extend
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
<a className="link-item" href="https://storybook.js.org/tutorials/" target="_blank">
|
||||||
|
<img src={Direction} alt="direction" />
|
||||||
|
<span>
|
||||||
|
<strong>In-depth guides</strong>
|
||||||
|
Best practices from leading teams
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
<a className="link-item" href="https://github.com/storybookjs/storybook" target="_blank">
|
||||||
|
<img src={Code} alt="code" />
|
||||||
|
<span>
|
||||||
|
<strong>GitHub project</strong>
|
||||||
|
View the source and add issues
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
<a className="link-item" href="https://discord.gg/storybook" target="_blank">
|
||||||
|
<img src={Comments} alt="comments" />
|
||||||
|
<span>
|
||||||
|
<strong>Discord chat</strong>
|
||||||
|
Chat with maintainers and the community
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="tip-wrapper">
|
||||||
|
<span className="tip">Tip</span>Edit the Markdown in{' '}
|
||||||
|
<code>stories/Introduction.stories.mdx</code>
|
||||||
|
</div>
|
||||||
29
src/stories/Page.stories.ts
Normal file
29
src/stories/Page.stories.ts
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react';
|
||||||
|
import { within, userEvent } from '@storybook/testing-library';
|
||||||
|
|
||||||
|
import { Page } from './Page';
|
||||||
|
|
||||||
|
const meta: Meta<typeof Page> = {
|
||||||
|
title: 'Example/Page',
|
||||||
|
component: Page,
|
||||||
|
parameters: {
|
||||||
|
// More on Story layout: https://storybook.js.org/docs/react/configure/story-layout
|
||||||
|
layout: 'fullscreen',
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof Page>;
|
||||||
|
|
||||||
|
export const LoggedOut: Story = {};
|
||||||
|
|
||||||
|
// More on interaction testing: https://storybook.js.org/docs/react/writing-tests/interaction-testing
|
||||||
|
export const LoggedIn: Story = {
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
const loginButton = await canvas.getByRole('button', {
|
||||||
|
name: /Log in/i,
|
||||||
|
});
|
||||||
|
await userEvent.click(loginButton);
|
||||||
|
},
|
||||||
|
};
|
||||||
73
src/stories/Page.tsx
Normal file
73
src/stories/Page.tsx
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
import React from 'react';
|
||||||
|
|
||||||
|
import { Header } from './Header';
|
||||||
|
import './page.css';
|
||||||
|
|
||||||
|
type User = {
|
||||||
|
name: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Page: React.FC = () => {
|
||||||
|
const [user, setUser] = React.useState<User>();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article>
|
||||||
|
<Header
|
||||||
|
user={user}
|
||||||
|
onLogin={() => setUser({ name: 'Jane Doe' })}
|
||||||
|
onLogout={() => setUser(undefined)}
|
||||||
|
onCreateAccount={() => setUser({ name: 'Jane Doe' })}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h2>Pages in Storybook</h2>
|
||||||
|
<p>
|
||||||
|
We recommend building UIs with a{' '}
|
||||||
|
<a href="https://componentdriven.org" target="_blank" rel="noopener noreferrer">
|
||||||
|
<strong>component-driven</strong>
|
||||||
|
</a>{' '}
|
||||||
|
process starting with atomic components and ending with pages.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Render pages with mock data. This makes it easy to build and review page states without
|
||||||
|
needing to navigate to them in your app. Here are some handy patterns for managing page
|
||||||
|
data in Storybook:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Use a higher-level connected component. Storybook helps you compose such data from the
|
||||||
|
"args" of child component stories
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Assemble data in the page component from your services. You can mock these services out
|
||||||
|
using Storybook.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
Get a guided tutorial on component-driven development at{' '}
|
||||||
|
<a href="renderers/react/template/cli/ts/Page" target="_blank" rel="noopener noreferrer">
|
||||||
|
Storybook tutorials
|
||||||
|
</a>
|
||||||
|
. Read more in the{' '}
|
||||||
|
<a href="https://storybook.js.org/docs" target="_blank" rel="noopener noreferrer">
|
||||||
|
docs
|
||||||
|
</a>
|
||||||
|
.
|
||||||
|
</p>
|
||||||
|
<div className="tip-wrapper">
|
||||||
|
<span className="tip">Tip</span> Adjust the width of the canvas with the{' '}
|
||||||
|
<svg width="10" height="10" viewBox="0 0 12 12" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<g fill="none" fillRule="evenodd">
|
||||||
|
<path
|
||||||
|
d="M1.5 5.2h4.8c.3 0 .5.2.5.4v5.1c-.1.2-.3.3-.4.3H1.4a.5.5 0 01-.5-.4V5.7c0-.3.2-.5.5-.5zm0-2.1h6.9c.3 0 .5.2.5.4v7a.5.5 0 01-1 0V4H1.5a.5.5 0 010-1zm0-2.1h9c.3 0 .5.2.5.4v9.1a.5.5 0 01-1 0V2H1.5a.5.5 0 010-1zm4.3 5.2H2V10h3.8V6.2z"
|
||||||
|
id="a"
|
||||||
|
fill="#999"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
Viewports addon in the toolbar
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</article>
|
||||||
|
);
|
||||||
|
};
|
||||||
1
src/stories/assets/code-brackets.svg
Normal file
1
src/stories/assets/code-brackets.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/code-brackets</title><g id="illustration/code-brackets" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#87E6E5" d="M11.4139325,12 C11.7605938,12 12,12.5059743 12,13.3779712 L12,17.4951758 L6.43502246,23.3839989 C5.85499251,23.9978337 5.85499251,25.0021663 6.43502246,25.6160011 L12,31.5048242 L12,35.6220288 C12,36.4939606 11.7605228,37 11.4139325,37 C11.2725831,37 11.1134406,36.9158987 10.9453839,36.7379973 L0.435022463,25.6160011 C-0.145007488,25.0021663 -0.145007488,23.9978337 0.435022463,23.3839989 L10.9453839,12.2620027 C11.1134051,12.0841663 11.2725831,12 11.4139325,12 Z M36.5860675,12 C36.7274169,12 36.8865594,12.0841013 37.0546161,12.2620027 L47.5649775,23.3839989 C48.1450075,23.9978337 48.1450075,25.0021663 47.5649775,25.6160011 L37.0546161,36.7379973 C36.8865949,36.9158337 36.7274169,37 36.5860675,37 C36.2394062,37 36,36.4940257 36,35.6220288 L36,31.5048242 L41.5649775,25.6160011 C42.1450075,25.0021663 42.1450075,23.9978337 41.5649775,23.3839989 L36,17.4951758 L36,13.3779712 C36,12.5060394 36.2394772,12 36.5860675,12 Z"/><rect id="Rectangle-7-Copy-5" width="35.57" height="4" x="5.009" y="22.662" fill="#A0DB77" rx="2" transform="translate(22.793959, 24.662305) rotate(-75.000000) translate(-22.793959, -24.662305)"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.4 KiB |
1
src/stories/assets/colors.svg
Normal file
1
src/stories/assets/colors.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 8.3 KiB |
1
src/stories/assets/comments.svg
Normal file
1
src/stories/assets/comments.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/comments</title><g id="illustration/comments" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Path" fill="#96D07C" d="M2.52730803,17.9196415 C2.44329744,17.9745167 2.36370847,18.000488 2.29303375,18.000488 C2.1197031,18.000488 2,17.8443588 2,17.5752855 L2,4 C2,1.790861 3.790861,3.23296945e-13 6,3.23296945e-13 L33.9995117,3.23296945e-13 C36.2086507,3.23296945e-13 37.9995117,1.790861 37.9995117,4 L37.9995117,9.999512 C37.9995117,12.208651 36.2086507,13.999512 33.9995117,13.999512 L8,13.999512 C7.83499225,13.999512 7.6723181,13.9895206 7.51254954,13.9701099 L2.52730803,17.9196415 Z"/><path id="Path" fill="#73E1E0" d="M7.51066,44.9703679 L2.52730803,47.9186655 C2.44329744,47.9735407 2.36370847,47.999512 2.29303375,47.999512 C2.1197031,47.999512 2,47.8433828 2,47.5743095 L2,35 C2,32.790861 3.790861,31 6,31 L26,31 C28.209139,31 30,32.790861 30,35 L30,41 C30,43.209139 28.209139,45 26,45 L8,45 C7.8343417,45 7.67103544,44.9899297 7.51066,44.9703679 Z"/><path id="Path" fill="#FFD476" d="M46,19.5 L46,33.0747975 C46,33.3438708 45.8802969,33.5 45.7069663,33.5 C45.6362915,33.5 45.5567026,33.4740287 45.472692,33.4191535 L40.4887103,29.4704446 C40.3285371,29.489956 40.1654415,29.5 40,29.5 L18,29.5 C15.790861,29.5 14,27.709139 14,25.5 L14,19.5 C14,17.290861 15.790861,15.5 18,15.5 L42,15.5 C44.209139,15.5 46,17.290861 46,19.5 Z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.5 KiB |
1
src/stories/assets/direction.svg
Normal file
1
src/stories/assets/direction.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/direction</title><g id="illustration/direction" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#FFD476" d="M23.4917015,33.6030641 L2.93840258,31.4321033 C2.38917316,31.3740904 1.99096346,30.8818233 2.04897631,30.3325939 C2.0747515,30.0885705 2.18934861,29.8625419 2.37095722,29.6975265 L34.2609105,0.721285325 C34.6696614,0.349881049 35.3021022,0.38015648 35.6735064,0.788907393 C35.9232621,1.06377731 36.0001133,1.45442096 35.8730901,1.80341447 L24.5364357,32.9506164 C24.3793473,33.3822133 23.9484565,33.6513092 23.4917015,33.6030641 L23.4917015,33.6030641 Z"/><path id="Combined-Shape-Copy" fill="#FFC445" d="M24.3163597,33.2881029 C24.0306575,33.0138462 23.9337246,32.5968232 24.069176,32.2246735 L35.091923,1.9399251 C35.2266075,1.56988243 35.5659249,1.31333613 35.9586669,1.28460955 C36.5094802,1.24432106 36.9886628,1.65818318 37.0289513,2.20899647 L40.2437557,46.1609256 C40.2644355,46.4436546 40.1641446,46.7218752 39.9678293,46.9263833 C39.5853672,47.3248067 38.9523344,47.3377458 38.5539111,46.9552837 L24.3163597,33.2881029 L24.3163597,33.2881029 Z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.3 KiB |
1
src/stories/assets/flow.svg
Normal file
1
src/stories/assets/flow.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/flow</title><g id="illustration/flow" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#79C9FC" fill-rule="nonzero" d="M30,29 C32.7614237,29 35,26.7614237 35,24 C35,14.6111593 27.3888407,7 18,7 C8.61115925,7 1,14.6111593 1,24 C1,33.3888407 8.61115925,41 18,41 C19.3333404,41 20.6447683,40.8466238 21.9154603,40.5471706 C19.5096374,39.3319645 17.5510566,37.8612875 16.0456579,36.1314815 C14.1063138,33.9030427 12.769443,31.0725999 12.0293806,27.6556449 C11.360469,26.565281 11,25.3082308 11,24 C11,20.1340068 14.1340068,17 18,17 C21.8659932,17 25,20.1340068 25,24 C25,26.125 27.7040312,29 30,29 Z"/><path id="Combined-Shape-Copy" fill="#FFC445" fill-rule="nonzero" d="M42,29 C44.7614237,29 47,26.7614237 47,24 C47,14.6111593 39.3888407,7 30,7 C20.6111593,7 13,14.6111593 13,24 C13,33.3888407 20.6111593,41 30,41 C31.3333404,41 32.6447683,40.8466238 33.9154603,40.5471706 C31.5096374,39.3319645 29.4051056,37.9781963 28.0456579,36.1314815 C26.0625,33.4375 23,27.1875 23,24 C23,20.1340068 26.1340068,17 30,17 C33.8659932,17 37,20.1340068 37,24 C37.02301,26.3435241 39.7040312,29 42,29 Z" transform="translate(30.000000, 24.000000) scale(-1, -1) translate(-30.000000, -24.000000)"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.4 KiB |
1
src/stories/assets/plugin.svg
Normal file
1
src/stories/assets/plugin.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/plugin</title><g id="illustration/plugin" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#79C9FC" d="M26,15.3994248 C26,15.4091303 26,15.4188459 26,15.4285714 L26,21.4694881 C25.8463595,21.4969567 25.6941676,21.51275 25.5873784,21.51275 C25.4974117,21.51275 25.4230979,21.4768034 25.377756,21.4206259 L25.2660784,21.2822603 L25.1317423,21.1657666 C24.2436317,20.3956144 23.100098,19.9633214 21.895551,19.9633214 C19.2039137,19.9633214 17,22.1075558 17,24.7804643 C17,27.4533728 19.2039137,29.5976071 21.895551,29.5976071 C23.1972122,29.5976071 24.3149423,29.2878193 25.1231445,28.3613697 C25.4542273,27.9818463 25.568273,27.9073214 25.5873784,27.9073214 C25.681532,27.9073214 25.8352452,27.9239643 26,27.9524591 L26,32.5714286 C26,32.5811541 26,32.5908697 26,32.6005752 L26,33 C26,35.209139 24.209139,37 22,37 L4,37 C1.790861,37 0,35.209139 0,33 L0,15 C0,12.790861 1.790861,11 4,11 L22,11 C24.209139,11 26,12.790861 26,15 L26,15.3994248 Z"/><path id="Path" fill="#87E6E5" d="M27.9998779,32.5714286 C27.9998779,33.3604068 28.6572726,34 29.4682101,34 L46.5315458,34 C47.3424832,34 47.9998779,33.3604068 47.9998779,32.5714286 L47.9998779,15.4285714 C47.9998779,14.6395932 47.3424832,14 46.5315458,14 L29.4682101,14 C28.6572726,14 27.9998779,14.6395932 27.9998779,15.4285714 L27.9998779,21.8355216 C27.9334367,22.2650514 27.8567585,22.6454496 27.746391,22.8084643 C27.4245309,23.2838571 26.2402709,23.51275 25.5873784,23.51275 C24.8705773,23.51275 24.2322714,23.1857725 23.8214379,22.6767605 C23.3096996,22.2329909 22.6349941,21.9633214 21.895551,21.9633214 C20.2963823,21.9633214 19,23.2245992 19,24.7804643 C19,26.3363293 20.2963823,27.5976071 21.895551,27.5976071 C22.5398535,27.5976071 23.2399343,27.477727 23.6160247,27.0466112 C24.1396029,26.4464286 24.7367044,25.9073214 25.5873784,25.9073214 C26.2402709,25.9073214 27.5912951,26.1766031 27.8226692,26.6116071 C27.8819199,26.7230038 27.9403239,26.921677 27.9998779,27.1556219 L27.9998779,32.5714286 Z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 2.1 KiB |
1
src/stories/assets/repo.svg
Normal file
1
src/stories/assets/repo.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/repo</title><g id="illustration/repo" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Rectangle-62-Copy" fill="#B7F0EF" d="M27.2217723,9.04506931 L41.2217723,6.2682098 C43.3886973,5.83840648 45.4937616,7.2466219 45.9235649,9.41354696 C45.9743993,9.66983721 46,9.93049166 46,10.1917747 L46,32.581381 C46,34.4904961 44.650862,36.1335143 42.7782277,36.5049459 L28.7782277,39.2818054 C26.6113027,39.7116087 24.5062384,38.3033933 24.0764351,36.1364682 C24.0256007,35.880178 24,35.6195235 24,35.3582405 L24,12.9686342 C24,11.0595191 25.349138,9.4165009 27.2217723,9.04506931 Z" opacity=".7"/><path id="Combined-Shape" fill="#87E6E5" d="M6.77822775,6.2682098 L20.7782277,9.04506931 C22.650862,9.4165009 24,11.0595191 24,12.9686342 L24,35.3582405 C24,37.5673795 22.209139,39.3582405 20,39.3582405 C19.738717,39.3582405 19.4780625,39.3326398 19.2217723,39.2818054 L5.22177225,36.5049459 C3.34913798,36.1335143 2,34.4904961 2,32.581381 L2,10.1917747 C2,7.98263571 3.790861,6.19177471 6,6.19177471 C6.26128305,6.19177471 6.5219375,6.21737537 6.77822775,6.2682098 Z"/><path id="Rectangle-63-Copy-2" fill="#61C1FD" d="M22,10 C23.1666667,10.2291667 24.0179036,10.625 24.5537109,11.1875 C25.0895182,11.75 25.5716146,12.875 26,14.5625 C26,29.3020833 26,37.5208333 26,39.21875 C26,40.9166667 26.4241536,42.9583333 27.2724609,45.34375 L24.5537109,41.875 L22.9824219,45.34375 C22.327474,43.1979167 22,41.2291667 22,39.4375 C22,37.6458333 22,27.8333333 22,10 Z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.6 KiB |
1
src/stories/assets/stackalt.svg
Normal file
1
src/stories/assets/stackalt.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/stackalt</title><g id="illustration/stackalt" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#FFAE00" d="M23.8628277,0 L23.8628277,48 L3.32291648,36.2491883 L3.32155653,11.9499781 L23.8628277,0 Z M23.8670509,0 L44.408322,11.9499781 L44.4069621,36.2491883 L23.8670509,48 L23.8670509,0 Z" opacity=".196"/><path id="Rectangle-46-Copy-3" fill="#66BF3C" d="M15.8232279,19.1155258 L24.7368455,21.4714881 C29.6053842,22.7582937 33.4077423,26.5606518 34.694548,31.4291905 L37.0505103,40.3428082 C37.6150232,42.4786032 36.3412474,44.6676353 34.2054524,45.2321482 C33.5569474,45.4035549 32.87575,45.4091235 32.2245294,45.2483418 L23.3459013,43.0562718 C18.2976962,41.809906 14.3561301,37.8683399 13.1097642,32.8201348 L10.9176943,23.9415066 C10.3881737,21.7967682 11.6975664,19.6288529 13.8423049,19.0993322 C14.4935255,18.9385505 15.1747229,18.9441191 15.8232279,19.1155258 Z" opacity=".5" transform="translate(23.999997, 32.166058) rotate(-45.000000) translate(-23.999997, -32.166058)"/><path id="Rectangle-46-Copy-2" fill="#FFAE00" d="M15.8232279,11.2216893 L24.7368455,13.5776516 C29.6053842,14.8644572 33.4077423,18.6668153 34.694548,23.5353541 L37.0505103,32.4489717 C37.6150232,34.5847667 36.3412474,36.7737988 34.2054524,37.3383117 C33.5569474,37.5097184 32.87575,37.515287 32.2245294,37.3545053 L23.3459013,35.1624353 C18.2976962,33.9160695 14.3561301,29.9745034 13.1097642,24.9262983 L10.9176943,16.0476701 C10.3881737,13.9029317 11.6975664,11.7350164 13.8423049,11.2054957 C14.4935255,11.044714 15.1747229,11.0502826 15.8232279,11.2216893 Z" opacity=".5" transform="translate(23.999997, 24.272222) rotate(-45.000000) translate(-23.999997, -24.272222)"/><path id="Rectangle-46-Copy" fill="#FC521F" d="M15.8232279,3.32785281 L24.7368455,5.68381509 C29.6053842,6.97062075 33.4077423,10.7729788 34.694548,15.6415176 L37.0505103,24.5551352 C37.6150232,26.6909302 36.3412474,28.8799623 34.2054524,29.4444752 C33.5569474,29.6158819 32.87575,29.6214505 32.2245294,29.4606688 L23.3459013,27.2685988 C18.2976962,26.022233 14.3561301,22.0806669 13.1097642,17.0324618 L10.9176943,8.15383364 C10.3881737,6.00909519 11.6975664,3.84117987 13.8423049,3.31165925 C14.4935255,3.15087753 15.1747229,3.15644615 15.8232279,3.32785281 Z" opacity=".5" transform="translate(23.999997, 16.378385) rotate(-45.000000) translate(-23.999997, -16.378385)"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 2.5 KiB |
30
src/stories/button.css
Normal file
30
src/stories/button.css
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
.storybook-button {
|
||||||
|
font-family: 'Nunito Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||||
|
font-weight: 700;
|
||||||
|
border: 0;
|
||||||
|
border-radius: 3em;
|
||||||
|
cursor: pointer;
|
||||||
|
display: inline-block;
|
||||||
|
line-height: 1;
|
||||||
|
}
|
||||||
|
.storybook-button--primary {
|
||||||
|
color: white;
|
||||||
|
background-color: #1ea7fd;
|
||||||
|
}
|
||||||
|
.storybook-button--secondary {
|
||||||
|
color: #333;
|
||||||
|
background-color: transparent;
|
||||||
|
box-shadow: rgba(0, 0, 0, 0.15) 0px 0px 0px 1px inset;
|
||||||
|
}
|
||||||
|
.storybook-button--small {
|
||||||
|
font-size: 12px;
|
||||||
|
padding: 10px 16px;
|
||||||
|
}
|
||||||
|
.storybook-button--medium {
|
||||||
|
font-size: 14px;
|
||||||
|
padding: 11px 20px;
|
||||||
|
}
|
||||||
|
.storybook-button--large {
|
||||||
|
font-size: 16px;
|
||||||
|
padding: 12px 24px;
|
||||||
|
}
|
||||||
32
src/stories/header.css
Normal file
32
src/stories/header.css
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
.wrapper {
|
||||||
|
font-family: 'Nunito Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||||
|
border-bottom: 1px solid rgba(0, 0, 0, 0.1);
|
||||||
|
padding: 15px 20px;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
}
|
||||||
|
|
||||||
|
svg {
|
||||||
|
display: inline-block;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-weight: 700;
|
||||||
|
font-size: 20px;
|
||||||
|
line-height: 1;
|
||||||
|
margin: 6px 0 6px 10px;
|
||||||
|
display: inline-block;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
button + button {
|
||||||
|
margin-left: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.welcome {
|
||||||
|
color: #333;
|
||||||
|
font-size: 14px;
|
||||||
|
margin-right: 10px;
|
||||||
|
}
|
||||||
69
src/stories/page.css
Normal file
69
src/stories/page.css
Normal file
|
|
@ -0,0 +1,69 @@
|
||||||
|
section {
|
||||||
|
font-family: 'Nunito Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 24px;
|
||||||
|
padding: 48px 20px;
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: 600px;
|
||||||
|
color: #333;
|
||||||
|
}
|
||||||
|
|
||||||
|
section h2 {
|
||||||
|
font-weight: 700;
|
||||||
|
font-size: 32px;
|
||||||
|
line-height: 1;
|
||||||
|
margin: 0 0 4px;
|
||||||
|
display: inline-block;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
section p {
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
section a {
|
||||||
|
text-decoration: none;
|
||||||
|
color: #1ea7fd;
|
||||||
|
}
|
||||||
|
|
||||||
|
section ul {
|
||||||
|
padding-left: 30px;
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
section li {
|
||||||
|
margin-bottom: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
section .tip {
|
||||||
|
display: inline-block;
|
||||||
|
border-radius: 1em;
|
||||||
|
font-size: 11px;
|
||||||
|
line-height: 12px;
|
||||||
|
font-weight: 700;
|
||||||
|
background: #e7fdd8;
|
||||||
|
color: #66bf3c;
|
||||||
|
padding: 4px 12px;
|
||||||
|
margin-right: 10px;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
section .tip-wrapper {
|
||||||
|
font-size: 13px;
|
||||||
|
line-height: 20px;
|
||||||
|
margin-top: 40px;
|
||||||
|
margin-bottom: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
section .tip-wrapper svg {
|
||||||
|
display: inline-block;
|
||||||
|
height: 12px;
|
||||||
|
width: 12px;
|
||||||
|
margin-right: 4px;
|
||||||
|
vertical-align: top;
|
||||||
|
margin-top: 3px;
|
||||||
|
}
|
||||||
|
|
||||||
|
section .tip-wrapper svg path {
|
||||||
|
fill: #1ea7fd;
|
||||||
|
}
|
||||||
30
src/withGlobals.ts
Normal file
30
src/withGlobals.ts
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
import type {
|
||||||
|
Renderer,
|
||||||
|
PartialStoryFn as StoryFunction,
|
||||||
|
StoryContext,
|
||||||
|
} from "@storybook/types";
|
||||||
|
import { useEffect, useGlobals } from "@storybook/preview-api";
|
||||||
|
import { PARAM_KEY } from "./constants";
|
||||||
|
|
||||||
|
export const withGlobals = (
|
||||||
|
StoryFn: StoryFunction<Renderer>,
|
||||||
|
context: StoryContext<Renderer>
|
||||||
|
) => {
|
||||||
|
const [globals] = useGlobals();
|
||||||
|
const state = globals[PARAM_KEY];
|
||||||
|
const { theme } = context.globals;
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
applyToolState(state);
|
||||||
|
}, [state, theme]);
|
||||||
|
|
||||||
|
return StoryFn();
|
||||||
|
};
|
||||||
|
|
||||||
|
function applyToolState(state: string | false) {
|
||||||
|
if (state) {
|
||||||
|
document.documentElement.dataset.misskeyTheme = state;
|
||||||
|
} else {
|
||||||
|
delete document.documentElement.dataset.misskeyTheme;
|
||||||
|
}
|
||||||
|
}
|
||||||
18
tsconfig.json
Normal file
18
tsconfig.json
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"baseUrl": ".",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"incremental": false,
|
||||||
|
"isolatedModules": true,
|
||||||
|
"jsx": "react",
|
||||||
|
"lib": ["es2020", "dom"],
|
||||||
|
"module": "commonjs",
|
||||||
|
"noImplicitAny": true,
|
||||||
|
"rootDir": "./src",
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"target": "ES2020"
|
||||||
|
},
|
||||||
|
"include": ["src/**/*"]
|
||||||
|
}
|
||||||
18
tsup.config.ts
Normal file
18
tsup.config.ts
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
import { defineConfig } from "tsup";
|
||||||
|
|
||||||
|
export default defineConfig((options) => ({
|
||||||
|
entry: ["src/index.ts", "src/preview.ts", "src/manager.ts"],
|
||||||
|
splitting: false,
|
||||||
|
minify: !options.watch,
|
||||||
|
format: ["cjs", "esm"],
|
||||||
|
dts: {
|
||||||
|
resolve: true,
|
||||||
|
},
|
||||||
|
treeshake: true,
|
||||||
|
sourcemap: true,
|
||||||
|
clean: true,
|
||||||
|
platform: "browser",
|
||||||
|
esbuildOptions(options) {
|
||||||
|
options.conditions = ["module"];
|
||||||
|
},
|
||||||
|
}));
|
||||||
7
vite.config.ts
Normal file
7
vite.config.ts
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
import { defineConfig } from "vite";
|
||||||
|
import react from "@vitejs/plugin-react";
|
||||||
|
|
||||||
|
// https://vitejs.dev/config/
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [react()],
|
||||||
|
});
|
||||||
Loading…
Reference in a new issue