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

feat: interactive stories for web components #3025

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

gavinbarron
Copy link
Member

Closes #

PR Type

  • Documentation content changes

Description of the changes

Adds the use of controls and parameters to Storybook. (Formerly known as knobs)
Adds an example story for mgt-person that allows for exploratory interactive editing of attributes and css properties.
Provides the HTML of the rendered story to allow developers to see what the markup would look like.

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

enable users to interactivly set component parameters without using an editor, this will improve discoverability for the attributes available to a developer
adds a patch to @whitespace/storybook-addon-html to bump the prettier version in use
Copy link
Contributor

Thank you for creating a Pull Request @gavinbarron.

This is a checklist for the PR reviewer(s) to complete before approving and merging this PR:

  • I have verified a documentation PR has been linked and is approved (or not applicable)
  • I have ran this PR locally and have tested the fix/feature
  • I have verified that stories have been added to storybook (or not applicable)
  • I have tested existing stories in storybook to verify no regression has occured
  • I have tested the solution in at least two browsers (Edge + 1 non-Chromium based browser)

@gavinbarron gavinbarron changed the title Feat/story args feat: interactive stories for web components Feb 7, 2024
Copy link

github-actions bot commented Feb 8, 2024

📖 The updated storybook is available here

Copy link

github-actions bot commented Feb 8, 2024

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 79% 72% 0
mgt-components.src.components.mgt-person-card 50% 65% 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 91% 73% 0
mgt-element.dist.es6.providers.src.providers 83% 69% 0
mgt-element.dist.es6.src 90% 100% 0
mgt-element.dist.es6.utils.src.utils 64% 76% 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 64% (13776 / 21450) 66% (395 / 598) 0

Copy link

github-actions bot commented Feb 8, 2024

📖 The updated storybook is available here

Copy link

sonarqubecloud bot commented May 6, 2024

Quality Gate Passed Quality Gate passed

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants