Skip to content

docs: use mdx for all webcomponents, add description of component #695

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

Closed
wants to merge 12 commits into from

Conversation

Lukas742
Copy link
Contributor

@Lukas742 Lukas742 commented Sep 29, 2020

Thank you for your contribution! 👏

To get it merged faster, kindly review the checklist below:

Pull Request Checklist

@github-actions
Copy link

github-actions bot commented Sep 29, 2020

Size Change: +9.74 kB (5%) 🔍

Total Size: 172 kB

Filename Size Change
packages/main/lib/Avatar.js 568 B +151 B (26%) 🚨
packages/main/lib/Badge.js 455 B +155 B (34%) 🚨
packages/main/lib/BusyIndicator.js 454 B +117 B (25%) 🚨
packages/main/lib/Button.js 463 B +112 B (24%) 🚨
packages/main/lib/Calendar.js 447 B +95 B (21%) 🚨
packages/main/lib/Card.js 500 B +173 B (34%) 🚨
packages/main/lib/Carousel.js 542 B +118 B (21%) 🚨
packages/main/lib/CheckBox.js 609 B +239 B (39%) 🚨
packages/main/lib/ComboBox.js 545 B +137 B (25%) 🚨
packages/main/lib/ComboBoxItem.js 328 B +39 B (11%) ⚠️
packages/main/lib/CustomListItem.js 458 B +114 B (24%) 🚨
packages/main/lib/DatePicker.js 614 B +149 B (24%) 🚨
packages/main/lib/DateRangePicker.js 567 B +83 B (14%) ⚠️
packages/main/lib/DateTimePicker.js 587 B +116 B (19%) ⚠️
packages/main/lib/Dialog.js 715 B +352 B (49%) 🚨
packages/main/lib/DurationPicker.js 557 B +124 B (22%) 🚨
packages/main/lib/FileUploader.js 694 B +311 B (44%) 🚨
packages/main/lib/FlexibleColumnLayout.js 515 B +145 B (28%) 🚨
packages/main/lib/GroupHeaderListItem.js 381 B +68 B (17%) ⚠️
packages/main/lib/Icon.js 520 B +197 B (37%) 🚨
packages/main/lib/Input.js 871 B +399 B (45%) 🚨
packages/main/lib/Label.js 590 B +268 B (45%) 🚨
packages/main/lib/Link.js 529 B +188 B (35%) 🚨
packages/main/lib/List.js 759 B +327 B (43%) 🚨
packages/main/lib/MessageStrip.js 518 B +167 B (32%) 🚨
packages/main/lib/MultiComboBox.js 699 B +280 B (40%) 🚨
packages/main/lib/MultiComboBoxItem.js 351 B +42 B (11%) ⚠️
packages/main/lib/NotificationListGroupItem.js 625 B +215 B (34%) 🚨
packages/main/lib/NotificationListItem.js 409 B +5 B (1%)
packages/main/lib/NotificationOverflowAction.js 587 B +277 B (47%) 🚨
packages/main/lib/ObjectPage.js 9.26 kB +123 B (1%)
packages/main/lib/Option.js 353 B +50 B (14%) ⚠️
packages/main/lib/Panel.js 484 B +105 B (21%) 🚨
packages/main/lib/Popover.js 636 B +151 B (23%) 🚨
packages/main/lib/ProductSwitch.js 392 B +104 B (26%) 🚨
packages/main/lib/ProductSwitchItem.js 444 B +104 B (23%) 🚨
packages/main/lib/ProgressIndicator.js 440 B +81 B (18%) ⚠️
packages/main/lib/RadioButton.js 611 B +233 B (38%) 🚨
packages/main/lib/RatingIndicator.js 439 B +94 B (21%) 🚨
packages/main/lib/ResponsivePopover.js 600 B +100 B (16%) ⚠️
packages/main/lib/SegmentedButton.js 490 B +190 B (38%) 🚨
packages/main/lib/Select.js 425 B +92 B (21%) 🚨
packages/main/lib/ShellBar.js 554 B +118 B (21%) 🚨
packages/main/lib/ShellBarItem.js 392 B +65 B (16%) ⚠️
packages/main/lib/SideNavigation.js 571 B +243 B (42%) 🚨
packages/main/lib/SideNavigationItem.js 406 B +69 B (16%) ⚠️
packages/main/lib/SideNavigationSubItem.js 378 B +49 B (12%) ⚠️
packages/main/lib/StandardListItem.js 517 B +110 B (21%) 🚨
packages/main/lib/SuggestionItem.js 445 B +48 B (10%) ⚠️
packages/main/lib/Switch.js 608 B +278 B (45%) 🚨
packages/main/lib/Tab.js 483 B +121 B (25%) 🚨
packages/main/lib/TabContainer.js 525 B +132 B (25%) 🚨
packages/main/lib/Table.js 622 B +276 B (44%) 🚨
packages/main/lib/TableCell.js 338 B +55 B (16%) ⚠️
packages/main/lib/TableColumn.js 408 B +76 B (18%) ⚠️
packages/main/lib/TableRow.js 319 B +38 B (11%) ⚠️
packages/main/lib/TabSeparator.js 344 B +61 B (17%) ⚠️
packages/main/lib/TextArea.js 658 B +208 B (31%) 🚨
packages/main/lib/Timeline.js 571 B +294 B (51%) 🆘
packages/main/lib/TimelineItem.js 358 B +21 B (5%) 🔍
packages/main/lib/TimePicker.js 549 B +150 B (27%) 🚨
packages/main/lib/Title.js 401 B +84 B (20%) 🚨
packages/main/lib/Toast.js 424 B +94 B (22%) 🚨
packages/main/lib/ToggleButton.js 653 B +282 B (43%) 🚨
packages/main/lib/Tree.js 423 B +60 B (14%) ⚠️
packages/main/lib/TreeItem.js 421 B +87 B (20%) 🚨
packages/main/lib/UploadCollection.js 474 B +96 B (20%) 🚨
packages/main/lib/UploadCollectionItem.js 471 B +35 B (7%) 🔍
ℹ️ View Unchanged
Filename Size Change
packages/base/lib/createComponentStyles.js 206 B 0 B
packages/base/lib/CssSizeVariables.js 918 B 0 B
packages/base/lib/Device.js 6.82 kB 0 B
packages/base/lib/hooks.js 1.42 kB 0 B
packages/base/lib/Logger.js 1.2 kB 0 B
packages/base/lib/Media.js 3.68 kB 0 B
packages/base/lib/spacing.js 997 B 0 B
packages/base/lib/StyleClassHelper.js 610 B 0 B
packages/base/lib/ThemingParameters.js 3.4 kB 0 B
packages/base/lib/useConsolidatedRef.js 271 B 0 B
packages/base/lib/usePassThroughHtmlProps.js 321 B 0 B
packages/base/lib/useViewportRange.js 452 B 0 B
packages/base/lib/Utils.js 647 B 0 B
packages/charts/lib/BarChart.js 3.81 kB 0 B
packages/charts/lib/BarChartPlaceholder.js 456 B 0 B
packages/charts/lib/ColumnChart.js 4.04 kB 0 B
packages/charts/lib/ColumnChartPlaceholder.js 514 B 0 B
packages/charts/lib/components/ChartContainer.js 941 B 0 B
packages/charts/lib/components/ChartDataLabel.js 605 B 0 B
packages/charts/lib/components/ComposedChartPlaceholder.js 878 B 0 B
packages/charts/lib/components/XAxisTicks.js 596 B 0 B
packages/charts/lib/components/YAxisTicks.js 513 B 0 B
packages/charts/lib/ComposedChart.js 4.77 kB 0 B
packages/charts/lib/DonutChart.js 2.73 kB 0 B
packages/charts/lib/LineChart.js 3.92 kB 0 B
packages/charts/lib/LineChartPlaceholder.js 529 B 0 B
packages/charts/lib/MicroBarChart.js 1.87 kB 0 B
packages/charts/lib/PieChart.js 2.67 kB 0 B
packages/charts/lib/PieChartPlaceholder.js 445 B 0 B
packages/charts/lib/RadarChart.js 2.01 kB 0 B
packages/charts/lib/RadialChart.js 1.08 kB 0 B
packages/charts/lib/ScatterChart.js 3.56 kB 0 B
packages/charts/lib/ScatterChartPlaceholder.js 535 B 0 B
packages/charts/lib/useLegendItemClick.js 391 B 0 B
packages/charts/lib/Utils.js 534 B 0 B
packages/main/lib/ActionSheet.js 1.21 kB 0 B
packages/main/lib/AnalyticalCard.js 748 B 0 B
packages/main/lib/AnalyticalCardHeader.js 2.69 kB 0 B
packages/main/lib/AnalyticalTable.js 16.8 kB 0 B
packages/main/lib/AnalyticalTableScrollMode.js 177 B 0 B
packages/main/lib/AvatarBackgroundColor.js 219 B 0 B
packages/main/lib/AvatarFitType.js 151 B 0 B
packages/main/lib/AvatarShape.js 150 B 0 B
packages/main/lib/AvatarSize.js 155 B 0 B
packages/main/lib/Bar.js 1.28 kB 0 B
packages/main/lib/BarDesign.js 177 B 0 B
packages/main/lib/Breadcrumbs.js 718 B 0 B
packages/main/lib/BreadcrumbsSeparatorStyle.js 198 B 0 B
packages/main/lib/BusyIndicatorSize.js 167 B 0 B
packages/main/lib/ButtonDesign.js 190 B 0 B
packages/main/lib/CalendarType.js 212 B 0 B
packages/main/lib/CarouselArrowsPlacement.js 166 B 0 B
packages/main/lib/ContentDensity.js 151 B 0 B
packages/main/lib/DeviationIndicator.js 160 B 0 B
packages/main/lib/FCLLayout.js 236 B 0 B
packages/main/lib/FilterBar.js 6.76 kB 0 B
packages/main/lib/FilterGroupItem.js 1.23 kB 0 B
packages/main/lib/FilterItem.js 1.62 kB 0 B
packages/main/lib/FilterType.js 170 B 0 B
packages/main/lib/FlexBox.js 967 B 0 B
packages/main/lib/FlexBoxAlignItems.js 189 B 0 B
packages/main/lib/FlexBoxDirection.js 169 B 0 B
packages/main/lib/FlexBoxJustifyContent.js 194 B 0 B
packages/main/lib/FlexBoxWrap.js 154 B 0 B
packages/main/lib/Form.js 2.57 kB 0 B
packages/main/lib/FormGroup.js 400 B 0 B
packages/main/lib/FormItem.js 1.05 kB 0 B
packages/main/lib/GlobalStyleClasses.js 151 B 0 B
packages/main/lib/Grid.js 1.58 kB 0 B
packages/main/lib/GridPosition.js 157 B 0 B
packages/main/lib/InputType.js 184 B 0 B
packages/main/lib/LinkDesign.js 191 B 0 B
packages/main/lib/ListItemTypes.js 160 B 0 B
packages/main/lib/ListMode.js 191 B 0 B
packages/main/lib/ListSeparators.js 186 B 0 B
packages/main/lib/Loader.js 1.3 kB 0 B
packages/main/lib/LoaderType.js 152 B 0 B
packages/main/lib/MessageBox.js 2.35 kB 0 B
packages/main/lib/MessageBoxActions.js 231 B 0 B
packages/main/lib/MessageBoxTypes.js 232 B 0 B
packages/main/lib/MessageStripType.js 181 B 0 B
packages/main/lib/ObjectPageMode.js 159 B 0 B
packages/main/lib/ObjectPageSection.js 1.25 kB 0 B
packages/main/lib/ObjectPageSubSection.js 1.08 kB 0 B
packages/main/lib/ObjectStatus.js 1.2 kB 0 B
packages/main/lib/Page.js 2.03 kB 0 B
packages/main/lib/PageBackgroundDesign.js 183 B 0 B
packages/main/lib/PanelAccessibleRoles.js 201 B 0 B
packages/main/lib/PlacementType.js 175 B 0 B
packages/main/lib/PopoverHorizontalAlign.js 181 B 0 B
packages/main/lib/PopoverPlacementType.js 172 B 0 B
packages/main/lib/PopoverVerticalAlign.js 204 B 0 B
packages/main/lib/Priority.js 163 B 0 B
packages/main/lib/SemanticColor.js 181 B 0 B
packages/main/lib/Size.js 151 B 0 B
packages/main/lib/Spinner.js 1.2 kB 0 B
packages/main/lib/TabContainerTabsPlacement.js 161 B 0 B
packages/main/lib/TabLayout.js 150 B 0 B
packages/main/lib/TablePlaceholder.js 771 B 0 B
packages/main/lib/TableScaleWidthMode.js 169 B 0 B
packages/main/lib/TableSelectionBehavior.js 178 B 0 B
packages/main/lib/TableSelectionMode.js 182 B 0 B
packages/main/lib/Text.js 798 B 0 B
packages/main/lib/TextAlign.js 183 B 0 B
packages/main/lib/ThemeProvider.js 1.16 kB 0 B
packages/main/lib/Themes.js 188 B 0 B
packages/main/lib/TitleLevel.js 163 B 0 B
packages/main/lib/ToastPlacement.js 208 B 0 B
packages/main/lib/Token.js 206 B 0 B
packages/main/lib/Tokenizer.js 223 B 0 B
packages/main/lib/Toolbar.js 3 kB 0 B
packages/main/lib/ToolbarDesign.js 175 B 0 B
packages/main/lib/ToolbarSeparator.js 477 B 0 B
packages/main/lib/ToolbarSpacer.js 220 B 0 B
packages/main/lib/ToolbarStyle.js 153 B 0 B
packages/main/lib/UploadState.js 170 B 0 B
packages/main/lib/ValueState.js 182 B 0 B
packages/main/lib/VariantManagement.js 2.05 kB 0 B
packages/main/lib/VerticalAlign.js 174 B 0 B
packages/main/lib/withWebComponent.js 1.58 kB 0 B

compressed-size-action

@coveralls
Copy link

coveralls commented Sep 29, 2020

Coverage Status

Coverage remained the same at 65.379% when pulling b8d469b on docs/enhance-webcomponents-storybook into 64d6d6a on master.

@Lukas742
Copy link
Contributor Author

Lukas742 commented Oct 6, 2020

Closed in favor of #707.
It makes more sense to create the stories one by one and not in a large "PR" like this.

@Lukas742 Lukas742 closed this Oct 6, 2020
@Lukas742 Lukas742 deleted the docs/enhance-webcomponents-storybook branch October 6, 2020 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants