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.

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

Improvement/storybook docs #661

Merged
merged 51 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
cd7d238
change name of button story, change name of button doc to match story…
JeanMarcMilletScality Nov 21, 2023
6b2c97f
draft template for docs
JeanMarcMilletScality Nov 21, 2023
e4e9d98
fix infoMessage story, delete ref to product name
JeanMarcMilletScality Nov 21, 2023
6e94e41
improve iconArgType, add it to chips
JeanMarcMilletScality Nov 21, 2023
de85f0e
add iconArgType to form, improve description of layout prop
JeanMarcMilletScality Nov 21, 2023
26664e7
add iconArgType in banner and dropdown stories
JeanMarcMilletScality Nov 21, 2023
88815cc
change icon of button, add some description
JeanMarcMilletScality Nov 21, 2023
a75241e
separate copybutton story
JeanMarcMilletScality Nov 21, 2023
6c19b96
delete knob addon
JeanMarcMilletScality Nov 22, 2023
2f7e5fc
delete addon knob
JeanMarcMilletScality Nov 22, 2023
fce943b
fixing tooltip
JeanMarcMilletScality Nov 22, 2023
f4d7ad6
put button.stories and button doc file together in a Button folder
JeanMarcMilletScality Nov 23, 2023
85eef4a
draft template
JeanMarcMilletScality Nov 23, 2023
6d28997
working on button docs
JeanMarcMilletScality Nov 24, 2023
51d07f7
draft table do/donts
JeanMarcMilletScality Nov 24, 2023
cae107e
work on button docs
JeanMarcMilletScality Dec 4, 2023
a55b224
delete button folder
JeanMarcMilletScality Dec 4, 2023
85073ab
fix import
JeanMarcMilletScality Dec 4, 2023
f04114f
merge selectv2 and selectipnut stories, delete rounded story as it is…
JeanMarcMilletScality Dec 4, 2023
dc5701c
change autodocs defaultName and add table of content
JeanMarcMilletScality Dec 5, 2023
a999f05
add title and heading selector to table of content
JeanMarcMilletScality Dec 5, 2023
13a6baf
draft for select doc
JeanMarcMilletScality Dec 5, 2023
f4ca570
delete remaining v2 folder
JeanMarcMilletScality Dec 5, 2023
2855481
move stories and docs file in folder
JeanMarcMilletScality Dec 5, 2023
1ff625f
sort storybook, put folder before lone component
JeanMarcMilletScality Dec 5, 2023
e15019f
add isTemplate to docs-template, so it is not display in storybook
JeanMarcMilletScality Dec 5, 2023
082c0ac
delete duplicate table in button guideline
JeanMarcMilletScality Dec 5, 2023
7ad448a
increase height story to see toast, change stories to new object format
JeanMarcMilletScality Dec 5, 2023
067ccb2
delete log
JeanMarcMilletScality Dec 6, 2023
5ef5b87
add keys when mapping
JeanMarcMilletScality Dec 6, 2023
9d85992
change in button guideline
JeanMarcMilletScality Dec 6, 2023
2004a02
add a link guideline and story, and usage of button size
JeanMarcMilletScality Dec 6, 2023
062f7f7
work on docs
JeanMarcMilletScality Dec 7, 2023
df650ee
correction of button guideline
JeanMarcMilletScality Dec 11, 2023
7d30bea
correction for select guideline, add useState in form story to enable…
JeanMarcMilletScality Dec 11, 2023
3364cd0
small corrections in guidelines
JeanMarcMilletScality Dec 22, 2023
a820734
fix import of CoreUITheme
JeanMarcMilletScality Dec 22, 2023
69bbcd0
change select guideline
JeanMarcMilletScality Dec 27, 2023
747d039
add loading state to button
JeanMarcMilletScality Dec 27, 2023
96c7da1
add loading button story
JeanMarcMilletScality Dec 27, 2023
3eb3ac7
update button guideline
JeanMarcMilletScality Dec 27, 2023
98d5587
improve story: fix icon render on some stories, better control for li…
JeanMarcMilletScality Dec 28, 2023
070ffb8
change searchInput and SelectInput story title to move them in Inputs
JeanMarcMilletScality Jan 9, 2024
e6c0b2d
delete div from SimpleForm story
JeanMarcMilletScality Jan 10, 2024
69fe937
remove additional actions, add height for icon story for better displ…
JeanMarcMilletScality Jan 10, 2024
f2f41d9
change story for canvas and add show code
JeanMarcMilletScality Jan 10, 2024
3d9c67b
change file name
JeanMarcMilletScality Jan 10, 2024
7b23f1a
rename guideline files
JeanMarcMilletScality Jan 10, 2024
df6598e
replace deprecated withsource with sourceState
JeanMarcMilletScality Jan 10, 2024
a7f4399
improve stories display : add global wrapper and remove from stories,…
JeanMarcMilletScality Dec 28, 2023
260d7b7
Update stories/InfoMessage/infomessage.guideline.mdx
JeanMarcMilletScality Jan 22, 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
6 changes: 3 additions & 3 deletions .storybook/main.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
module.exports = {
stories: ['../stories/**/*.@(mdx|stories.@(ts|tsx))'],
stories: ['../stories/**/*.@(mdx|stories.@(ts|tsx))', '../src/**/**/*.@(mdx|stories.@(ts|tsx))'],

addons: [
'@storybook/addon-essentials',
'@storybook/addon-storysource',
// '@storybook/addon-knobs',
'@storybook/addon-mdx-gfm'
],

Expand All @@ -26,6 +25,7 @@ module.exports = {
},

docs: {
autodocs: true
autodocs: true,
defaultName: 'Stories',
}
};
15 changes: 14 additions & 1 deletion .storybook/preview.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React from 'react';
import { QueryClient, QueryClientProvider } from 'react-query';
import { CoreUiThemeProvider } from '../src/lib/next';
import { brand, coreUIAvailableThemes} from '../src/lib/style/theme';
import { Wrapper } from '../stories/common';


export const globalTypes = {
Expand All @@ -19,10 +20,16 @@ export const globalTypes = {

const withThemeProvider = (Story, context) => {
const theme = coreUIAvailableThemes[context.globals.theme];
const {viewMode} = context
return (
<QueryClientProvider client={new QueryClient()}>
<CoreUiThemeProvider theme={theme}>
<Story {...context} />
{/* Wrapper to make the stories take the full screen but not in docs */}
<div style={viewMode === 'story' ? {height: 100 + 'vh' }: null}>
<Wrapper>
<Story {...context} />
</Wrapper>
</div>
</CoreUiThemeProvider>
</QueryClientProvider>
);
Expand All @@ -31,6 +38,11 @@ const withThemeProvider = (Story, context) => {
export const decorators = [withThemeProvider];

export const parameters = {
layout: 'fullscreen',
docs:{
toc : {headingSelector: 'h2,h3',
title: "Table of Contents"},
},
controls:{
//All props with color in name will automatically have a control 'color'
//with colors presets to theme colors, possible to have the color name from theme in control
Expand All @@ -47,6 +59,7 @@ export const parameters = {
'Guidelines',
'Templates',
'Components',
['Navigation', 'Data Display', 'Inputs', 'Feedback', 'Progress & loading', 'Styling', 'Deprecated']

],
},
Expand Down
Loading
Loading