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: adding react snippets in Storybook #2934

Merged
merged 33 commits into from
Jan 24, 2024
Merged

docs: adding react snippets in Storybook #2934

merged 33 commits into from
Jan 24, 2024

Conversation

sebastienlevert
Copy link
Contributor

Closes #2929

PR Type

  • Documentation content changes

Description of the changes

Adding a new set of stories for each component that focused on React. We are not rendering the React components, we are only showcasing the snippets. This is a first step towards more complete React docs in Storybook.

PR checklist

  • Project builds (yarn build) and changes have been tested in at least two supported browsers (Edge + non-Chromium based browser)
  • All public APIs (classes, methods, etc) have been documented following the jsdoc syntax
  • Stories have been added and existing stories have been tested
  • Added appropriate documentation. Docs PR:
  • License header has been added to all new source files (yarn setLicense)
  • Contains NO breaking changes

Other information

This will probably require a Docs PR to replace the previous stories with the HTML ones (moved in Storybook) and to include a new tab control to showcase the React ones.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 4, 2024

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 4, 2024

📖 The updated storybook is available here

gavinbarron
gavinbarron reviewed Jan 4, 2024
View reviewed changes
.storybook/main.js Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024

📖 The updated storybook is available here

@sebastienlevert sebastienlevert marked this pull request as ready for review January 9, 2024 20:10
@sebastienlevert sebastienlevert requested a review from a team as a code owner January 9, 2024 20:10
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 9, 2024

📖 The updated storybook is available here

gavinbarron
gavinbarron reviewed Jan 9, 2024
View reviewed changes
package.json Outdated Show resolved Hide resolved
packages/mgt-components/src/components/mgt-login/mgt-login.ts Show resolved Hide resolved
.storybook/addons/codeEditorAddon/codeAddon.js Outdated Show resolved Hide resolved
.storybook/addons/codeEditorAddon/codeAddon.js Outdated Show resolved Hide resolved
.storybook/addons/codeEditorAddon/codeAddon.js Outdated Show resolved Hide resolved
.storybook/main.js Outdated Show resolved Hide resolved
.storybook/utils/utils.js Outdated Show resolved Hide resolved
.storybook/addons/codeEditorAddon/editor.js Outdated Show resolved Hide resolved
stories/components/agenda/agenda.react.stories.js Outdated Show resolved Hide resolved
stories/components/get/get.react.stories.js Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

1 similar comment
@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

@gavinbarron gavinbarron mentioned this pull request Jan 24, 2024
Closed
@sebastienlevert sebastienlevert mentioned this pull request Jan 24, 2024
Merged
6 tasks
@sebastienlevert
Copy link
Contributor Author

#2962 should be merged before we merge this one. Changes will be required as it will impacts the enums used in React.

@gavinbarron
Copy link
Member

Love the update to the auth page, nice one!

@sebastienlevert
Copy link
Contributor Author

This should be ready to be merged!

@sebastienlevert sebastienlevert enabled auto-merge (squash) January 24, 2024 18:37
@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

1 similar comment
@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

@gavinbarron
Copy link
Member

@sebastienlevert this looks good to me, but there's a conflict that needs to be resolved before I can approve

@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

@github-actions GitHub Actions
Copy link

Code Coverage

Package Line Rate Branch Rate Complexity Health
mgt-components.src.components 85% 67% 0 ✔
mgt-components.src.components.mgt-contact 63% 100% 0 ➖
mgt-components.src.components.mgt-file 62% 100% 0 ➖
mgt-components.src.components.mgt-file-list 46% 100% 0 ❌
mgt-components.src.components.mgt-file-list.mgt-file-upload 49% 86% 0 ❌
mgt-components.src.components.mgt-get 22% 100% 0 ❌
mgt-components.src.components.mgt-messages 68% 100% 0 ➖
mgt-components.src.components.mgt-organization 47% 100% 0 ❌
mgt-components.src.components.mgt-person 78% 65% 0 ✔
mgt-components.src.components.mgt-person-card 56% 54% 0 ➖
mgt-components.src.components.mgt-picker 80% 100% 0 ✔
mgt-components.src.components.mgt-profile 40% 100% 0 ❌
mgt-components.src.components.mgt-tasks-base 87% 100% 0 ✔
mgt-components.src.components.mgt-theme-toggle 100% 100% 0 ✔
mgt-components.src.components.mgt-todo 79% 100% 0 ✔
mgt-components.src.components.sub-components.mgt-flyout 72% 53% 0 ➖
mgt-components.src.components.sub-components.mgt-spinner 100% 100% 0 ✔
mgt-components.src.graph 38% 78% 0 ❌
mgt-components.src.styles 92% 80% 0 ✔
mgt-components.src.utils 78% 12% 0 ✔
mgt-element.dist.es6.components.src.components 72% 73% 0 ➖
mgt-element.dist.es6.mock.src.mock 90% 72% 0 ✔
mgt-element.dist.es6.providers.src.providers 85% 73% 0 ✔
mgt-element.dist.es6.src 91% 80% 0 ✔
mgt-element.dist.es6.utils.src.utils 66% 69% 0 ➖
mgt-element.src 93% 40% 0 ✔
mgt-element.src.components 78% 100% 0 ✔
mgt-element.src.mock 81% 56% 0 ✔
mgt-element.src.providers 83% 91% 0 ✔
mgt-element.src.utils 71% 90% 0 ➖
Summary 65% (13924 / 21438) 63% (402 / 634) 0 ➖

@github-actions GitHub Actions
Copy link

📖 The updated storybook is available here

@sebastienlevert sebastienlevert enabled auto-merge (squash) January 24, 2024 20:20
@sebastienlevert sebastienlevert merged commit 2fb1064 into main Jan 24, 2024
9 checks passed
@sebastienlevert sebastienlevert deleted the sebastienlevert/react-in-storybook branch January 24, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gavinbarron gavinbarron gavinbarron approved these changes

@musale musale Awaiting requested review from musale

Assignees
No one assigned
Labels
Build: Storybook
Projects
Graph Toolkit
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs] Storybook should have React code snippets.
2 participants
@sebastienlevert @gavinbarron