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

Jump to bottom

docs: demos intro, changelog reformat and storybook styling #1022

Merged
merged 3 commits into from
Apr 25, 2023
Merged

docs: demos intro, changelog reformat and storybook styling #1022

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7cfb0c
docs: changelog reformat; demos intro and changelog rework
Golodhros Apr 25, 2023
65236a2
docs: some storybook customization
Golodhros Apr 25, 2023
4c84eb6
Update packages/demos/.storybook/preview-head.html
Golodhros Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
304 changes: 103 additions & 201 deletions CHANGELOG.md
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion packages/core/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
const path = require('path');

module.exports = {
stories: ['../src/**/*.stories.[tj]s'],
stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.[tj]s'],
addons: [
'@storybook/addon-viewport/register',
'@storybook/addon-a11y',
'@storybook/addon-actions',
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/addon-interactions',
],
webpackFinal: async (config, { configType }) => {
// `configType` has a value of 'DEVELOPMENT' or 'PRODUCTION'
Expand Down
6 changes: 6 additions & 0 deletions packages/core/.storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,10 @@ addParameters({
options: {},
},
layout: 'fullscreen',
options: {
storySort: {
method: 'alphabetical',
order: ['Welcome', ['CHARTS'], 'Changelog'],
},
},
});
3 changes: 2 additions & 1 deletion packages/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"@storybook/addon-a11y": "^6.5.9",
"@storybook/addon-actions": "^6.5.9",
"@storybook/addon-console": "^1.2.3",
"@storybook/addon-docs": "^6.5.9",
"@storybook/addon-viewport": "^6.5.9",
"@storybook/html": "^6.5.9",
"@types/d3-selection": "^1.4.1",
Expand Down Expand Up @@ -145,7 +146,7 @@
"lint": "yarn run lint:js && yarn run lint:styles",
"prebuild": "yarn run clean",
"start": "yarn run demo",
"storybook": "start-storybook -p 1001",
"storybook": "start-storybook -p 2001",
"test:watch": "jest --watch --colors",
"test": "jest --colors"
}
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/README.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { Meta, Description } from '@storybook/addon-docs';

import Readme from '!raw-loader!../README.md';

<Meta title="Welcome" />

<Description markdown={Readme} />
15 changes: 11 additions & 4 deletions packages/demos/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
module.exports = {
stories: ['../src/*.stories.[tj]s'],
addons: [],
stories: ['../src/**/*.stories.mdx', '../src/*.stories.[tj]s'],
addons: [
'@storybook/addon-viewport/register',
'@storybook/addon-a11y',
'@storybook/addon-actions',
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/addon-interactions',
],

// Reference: Storybook composition: https://storybook.js.org/docs/react/sharing/storybook-composition
refs: (_, { configType }) => {
if (configType === 'DEVELOPMENT') {
return {
core: {
title: 'Britecharts Core',
url: 'http://localhost:1001',
url: 'http://localhost:2001',
},
react: {
title: 'Britecharts React',
url: 'http://localhost:1002',
url: 'http://localhost:2002',
},
};
}
Expand Down
6 changes: 3 additions & 3 deletions packages/demos/.storybook/preview-head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- https://storybook.js.org/docs/configurations/add-custom-head-tags/#docs-content -->
<!-- Favicon -->
<link rel="shortcut icon" href="img/icons/favicon.ico">
<link rel="icon" type="image/png" href="img/icons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="img/icons/favicon-16x16.png" sizes="16x16">
<link rel="shortcut icon" href="../../docs/static/img/icons/favicon.ico">
<link rel="icon" type="image/png" href="../../docs/static/img/icons/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/png" href="../../docs/static/img/icons/favicon-32x32.png" sizes="32x32">

<link type="text/css" rel="stylesheet" href="/dist/styles/bundle/britecharts.css" />
Golodhros marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 6 additions & 0 deletions packages/demos/.storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,10 @@ addParameters({
options: {},
},
layout: 'fullscreen',
options: {
storySort: {
method: '',
order: ['Introduction', 'Changelog'],
},
},
});
4 changes: 3 additions & 1 deletion packages/demos/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"packageManager": "yarn@3.2.0",
"version": "0.0.0",
"devDependencies": {
"@storybook/addons": "^6.5.9",
"@storybook/html": "^6.5.9",
"@storybook/theming": "^6.5.9",
"chromatic": "^6.15.0"
},
"scripts": {
Expand All @@ -13,6 +15,6 @@
"demo": "yarn storybook",
"prebuild": "yarn run clean",
"start": "yarn storybook",
"storybook": "start-storybook -p 1000"
"storybook": "start-storybook -p 2000"
}
}
3 changes: 0 additions & 3 deletions packages/demos/src/welcome.html
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions packages/demos/src/welcome.stories.js
View file
Open in desktop

This file was deleted.

3 changes: 3 additions & 0 deletions packages/react/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ module.exports = {
'../src/**/*.stories.@(js|jsx|ts|tsx)',
],
addons: [
'@storybook/addon-viewport/register',
'@storybook/addon-a11y',
'@storybook/addon-actions',
'@storybook/addon-links',
'@storybook/addon-essentials',
'@storybook/addon-interactions',
Expand Down
1 change: 1 addition & 0 deletions packages/react/.storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { addParameters } from '@storybook/react';
import '@storybook/addon-console';
import '../../core/dist/styles/bundle/britecharts.css';

addParameters({
a11y: {
Expand Down
2 changes: 1 addition & 1 deletion packages/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"demo": "yarn run storybook",
"prebuild": "yarn run clean",
"start": "webpack-dev-server --env=test --open --hot",
"storybook": "start-storybook -p 1002",
"storybook": "start-storybook -p 2002",
"test:watch": "jest --watch --colors",
"test": "jest --colors"
}
Expand Down
7 changes: 0 additions & 7 deletions packages/react/src/CHANGELOG.stories.mdx
View file
Open in desktop

This file was deleted.

114 changes: 114 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3433,6 +3433,7 @@ __metadata:
"@storybook/addon-a11y": ^6.5.9
"@storybook/addon-actions": ^6.5.9
"@storybook/addon-console": ^1.2.3
"@storybook/addon-docs": ^6.5.9
"@storybook/addon-viewport": ^6.5.9
"@storybook/html": ^6.5.9
"@types/d3-selection": ^1.4.1
Expand Down Expand Up @@ -3483,7 +3484,9 @@ __metadata:
version: 0.0.0-use.local
resolution: "@britecharts/demos@workspace:packages/demos"
dependencies:
"@storybook/addons": ^6.5.9
"@storybook/html": ^6.5.9
"@storybook/theming": ^6.5.9
chromatic: ^6.15.0
languageName: unknown
linkType: soft
Expand Down Expand Up @@ -5600,6 +5603,56 @@ __metadata:
languageName: node
linkType: hard

"@storybook/addons@npm:^6.5.9":
version: 6.5.16
resolution: "@storybook/addons@npm:6.5.16"
dependencies:
"@storybook/api": 6.5.16
"@storybook/channels": 6.5.16
"@storybook/client-logger": 6.5.16
"@storybook/core-events": 6.5.16
"@storybook/csf": 0.0.2--canary.4566f4d.1
"@storybook/router": 6.5.16
"@storybook/theming": 6.5.16
"@types/webpack-env": ^1.16.0
core-js: ^3.8.2
global: ^4.4.0
regenerator-runtime: ^0.13.7
peerDependencies:
react: ^16.8.0 || ^17.0.0 || ^18.0.0
react-dom: ^16.8.0 || ^17.0.0 || ^18.0.0
checksum: 0463150e4cf7bd2b2aaafdbaadfb4420e4e0a31eb651cfc1a2d7f4b4974caf67878712602474585dfa18f583000608598045594909959d2e9e2ec32ba004392d
languageName: node
linkType: hard

"@storybook/api@npm:6.5.16":
version: 6.5.16
resolution: "@storybook/api@npm:6.5.16"
dependencies:
"@storybook/channels": 6.5.16
"@storybook/client-logger": 6.5.16
"@storybook/core-events": 6.5.16
"@storybook/csf": 0.0.2--canary.4566f4d.1
"@storybook/router": 6.5.16
"@storybook/semver": ^7.3.2
"@storybook/theming": 6.5.16
core-js: ^3.8.2
fast-deep-equal: ^3.1.3
global: ^4.4.0
lodash: ^4.17.21
memoizerific: ^1.11.3
regenerator-runtime: ^0.13.7
store2: ^2.12.0
telejson: ^6.0.8
ts-dedent: ^2.0.0
util-deprecate: ^1.0.2
peerDependencies:
react: ^16.8.0 || ^17.0.0 || ^18.0.0
react-dom: ^16.8.0 || ^17.0.0 || ^18.0.0
checksum: c873189ac1e501825d647903baa125899c492cee962cb86ebb7455110bd09194eeb6943f5c58a1f808ce4ee2e20e305f5604a4e60b07003c82a6fc6ceaee5ea9
languageName: node
linkType: hard

"@storybook/api@npm:6.5.9":
version: 6.5.9
resolution: "@storybook/api@npm:6.5.9"
Expand Down Expand Up @@ -5717,6 +5770,17 @@ __metadata:
languageName: node
linkType: hard

"@storybook/channels@npm:6.5.16":
version: 6.5.16
resolution: "@storybook/channels@npm:6.5.16"
dependencies:
core-js: ^3.8.2
ts-dedent: ^2.0.0
util-deprecate: ^1.0.2
checksum: 3d7f7bc19ed7b250976e00e02ab544408806b439106bed18a5db9815612f6c5df9bdf7c1a97b5a40ba3194184ebe7e4c75e2bca5496025d6b26afefa95cfccbd
languageName: node
linkType: hard

"@storybook/channels@npm:6.5.9":
version: 6.5.9
resolution: "@storybook/channels@npm:6.5.9"
Expand Down Expand Up @@ -5759,6 +5823,16 @@ __metadata:
languageName: node
linkType: hard

"@storybook/client-logger@npm:6.5.16":
version: 6.5.16
resolution: "@storybook/client-logger@npm:6.5.16"
dependencies:
core-js: ^3.8.2
global: ^4.4.0
checksum: 0a86959b1bacb1b893e282173b48afe9c857b8cdc67a47ad87a7f11ba7dbc15ebc4f0d05c07dffb988e0cd3e1de0f09f300ee06c66afe4c50e9be83aaed75971
languageName: node
linkType: hard

"@storybook/client-logger@npm:6.5.9, @storybook/client-logger@npm:^6.4.0":
version: 6.5.9
resolution: "@storybook/client-logger@npm:6.5.9"
Expand Down Expand Up @@ -5889,6 +5963,15 @@ __metadata:
languageName: node
linkType: hard

"@storybook/core-events@npm:6.5.16":
version: 6.5.16
resolution: "@storybook/core-events@npm:6.5.16"
dependencies:
core-js: ^3.8.2
checksum: 1844bdabfb7828af7ddd54129fbb321bf65d8b65459eaac99c8f3f94c7c2f0ee000468362758076444083f863a3bc835ecd1e4f2128524eb5c00c8a576473bc9
languageName: node
linkType: hard

"@storybook/core-events@npm:6.5.9":
version: 6.5.9
resolution: "@storybook/core-events@npm:6.5.9"
Expand Down Expand Up @@ -6278,6 +6361,22 @@ __metadata:
languageName: node
linkType: hard

"@storybook/router@npm:6.5.16":
version: 6.5.16
resolution: "@storybook/router@npm:6.5.16"
dependencies:
"@storybook/client-logger": 6.5.16
core-js: ^3.8.2
memoizerific: ^1.11.3
qs: ^6.10.0
regenerator-runtime: ^0.13.7
peerDependencies:
react: ^16.8.0 || ^17.0.0 || ^18.0.0
react-dom: ^16.8.0 || ^17.0.0 || ^18.0.0
checksum: 2812b93997026b1d85f02072d04f18e98e24de288efb73402f8d15ececd390e13dc620ef011268e09986c629f497ffa03230c2431e89b4e37c01b70761be2c6d
languageName: node
linkType: hard

"@storybook/router@npm:6.5.9":
version: 6.5.9
resolution: "@storybook/router@npm:6.5.9"
Expand Down Expand Up @@ -6386,6 +6485,21 @@ __metadata:
languageName: node
linkType: hard

"@storybook/theming@npm:6.5.16, @storybook/theming@npm:^6.5.9":
version: 6.5.16
resolution: "@storybook/theming@npm:6.5.16"
dependencies:
"@storybook/client-logger": 6.5.16
core-js: ^3.8.2
memoizerific: ^1.11.3
regenerator-runtime: ^0.13.7
peerDependencies:
react: ^16.8.0 || ^17.0.0 || ^18.0.0
react-dom: ^16.8.0 || ^17.0.0 || ^18.0.0
checksum: 349affa5c5208240291a5d24c73d852e220bfaf36b8fda70564aec1cac6070248ce7566ccb755c55a6ce0844ab2bbfd55881f6f788240b38cb407714e393c6f3
languageName: node
linkType: hard

"@storybook/theming@npm:6.5.9":
version: 6.5.9
resolution: "@storybook/theming@npm:6.5.9"
Expand Down