Skip to content

docs(FilterBar): add JSDoc comments, enhance story #936

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
Merged
merged 2 commits into from
Nov 11, 2020
Merged

docs(FilterBar): add JSDoc comments, enhance story #936

merged 2 commits into from
Nov 11, 2020

Conversation

Lukas742
Copy link
Contributor

@Lukas742 Lukas742 commented Nov 11, 2020 •
edited
Loading

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 Nov 11, 2020 •
edited
Loading

Size Change: +390 B (0%)

Total Size: 182 kB

Filename Size Change
packages/main/lib/FilterBar.js 7.05 kB +353 B (5%) 🔍
packages/main/lib/FilterGroupItem.js 1.27 kB +37 B (2%)
ℹ️ 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.45 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 999 B 0 B
packages/base/lib/StyleClassHelper.js 610 B 0 B
packages/base/lib/ThemingParameters.js 3.6 kB 0 B
packages/base/lib/useConsolidatedRef.js 271 B 0 B
packages/base/lib/usePassThroughHtmlProps.js 327 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.36 kB 0 B
packages/main/lib/AnalyticalCard.js 852 B 0 B
packages/main/lib/AnalyticalCardHeader.js 2.69 kB 0 B
packages/main/lib/AnalyticalTable.js 17.9 kB 0 B
packages/main/lib/AnalyticalTableScrollMode.js 177 B 0 B
packages/main/lib/Avatar.js 563 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/Badge.js 451 B 0 B
packages/main/lib/Bar.js 1.41 kB 0 B
packages/main/lib/BarDesign.js 177 B 0 B
packages/main/lib/Breadcrumbs.js 795 B 0 B
packages/main/lib/BreadcrumbsSeparatorStyle.js 198 B 0 B
packages/main/lib/BusyIndicator.js 450 B 0 B
packages/main/lib/BusyIndicatorSize.js 167 B 0 B
packages/main/lib/Button.js 475 B 0 B
packages/main/lib/ButtonDesign.js 190 B 0 B
packages/main/lib/Calendar.js 444 B 0 B
packages/main/lib/CalendarType.js 212 B 0 B
packages/main/lib/Card.js 496 B 0 B
packages/main/lib/Carousel.js 538 B 0 B
packages/main/lib/CarouselArrowsPlacement.js 166 B 0 B
packages/main/lib/CheckBox.js 604 B 0 B
packages/main/lib/ComboBox.js 549 B 0 B
packages/main/lib/ComboBoxItem.js 323 B 0 B
packages/main/lib/ContentDensity.js 151 B 0 B
packages/main/lib/CustomListItem.js 454 B 0 B
packages/main/lib/DatePicker.js 620 B 0 B
packages/main/lib/DateRangePicker.js 573 B 0 B
packages/main/lib/DateTimePicker.js 592 B 0 B
packages/main/lib/DeviationIndicator.js 160 B 0 B
packages/main/lib/Dialog.js 724 B 0 B
packages/main/lib/DurationPicker.js 559 B 0 B
packages/main/lib/DynamicPage.js 4.08 kB 0 B
packages/main/lib/DynamicPageHeader.js 1.33 kB 0 B
packages/main/lib/DynamicPageTitle.js 1.47 kB 0 B
packages/main/lib/FCLLayout.js 236 B 0 B
packages/main/lib/FileUploader.js 695 B 0 B
packages/main/lib/FlexBox.js 1.08 kB 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/FlexibleColumnLayout.js 511 B 0 B
packages/main/lib/Form.js 2.66 kB 0 B
packages/main/lib/FormGroup.js 547 B 0 B
packages/main/lib/FormItem.js 1.17 kB 0 B
packages/main/lib/GlobalStyleClasses.js 151 B 0 B
packages/main/lib/Grid.js 1.64 kB 0 B
packages/main/lib/GridPosition.js 157 B 0 B
packages/main/lib/GroupHeaderListItem.js 372 B 0 B
packages/main/lib/Icon.js 516 B 0 B
packages/main/lib/Input.js 864 B 0 B
packages/main/lib/InputType.js 184 B 0 B
packages/main/lib/Label.js 587 B 0 B
packages/main/lib/Link.js 524 B 0 B
packages/main/lib/LinkDesign.js 191 B 0 B
packages/main/lib/List.js 753 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.47 kB 0 B
packages/main/lib/LoaderType.js 152 B 0 B
packages/main/lib/MessageBox.js 2.5 kB 0 B
packages/main/lib/MessageBoxActions.js 231 B 0 B
packages/main/lib/MessageBoxTypes.js 232 B 0 B
packages/main/lib/MessageStrip.js 514 B 0 B
packages/main/lib/MessageStripType.js 181 B 0 B
packages/main/lib/MultiComboBox.js 703 B 0 B
packages/main/lib/MultiComboBoxItem.js 347 B 0 B
packages/main/lib/MultiInput.js 735 B 0 B
packages/main/lib/NotificationListGroupItem.js 619 B 0 B
packages/main/lib/NotificationListItem.js 699 B 0 B
packages/main/lib/NotificationOverflowAction.js 434 B 0 B
packages/main/lib/ObjectPage.js 9.25 kB 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.24 kB 0 B
packages/main/lib/Option.js 351 B 0 B
packages/main/lib/Page.js 2.08 kB 0 B
packages/main/lib/PageBackgroundDesign.js 183 B 0 B
packages/main/lib/Panel.js 479 B 0 B
packages/main/lib/PanelAccessibleRoles.js 201 B 0 B
packages/main/lib/PlacementType.js 175 B 0 B
packages/main/lib/Popover.js 629 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/ProductSwitch.js 388 B 0 B
packages/main/lib/ProductSwitchItem.js 439 B 0 B
packages/main/lib/ProgressIndicator.js 435 B 0 B
packages/main/lib/RadioButton.js 600 B 0 B
packages/main/lib/RatingIndicator.js 434 B 0 B
packages/main/lib/ResponsivePopover.js 595 B 0 B
packages/main/lib/SegmentedButton.js 486 B 0 B
packages/main/lib/Select.js 438 B 0 B
packages/main/lib/SemanticColor.js 181 B 0 B
packages/main/lib/ShellBar.js 551 B 0 B
packages/main/lib/ShellBarItem.js 388 B 0 B
packages/main/lib/SideNavigation.js 568 B 0 B
packages/main/lib/SideNavigationItem.js 402 B 0 B
packages/main/lib/SideNavigationSubItem.js 373 B 0 B
packages/main/lib/Size.js 151 B 0 B
packages/main/lib/Spinner.js 1.42 kB 0 B
packages/main/lib/StandardListItem.js 514 B 0 B
packages/main/lib/SuggestionItem.js 439 B 0 B
packages/main/lib/Switch.js 610 B 0 B
packages/main/lib/Tab.js 479 B 0 B
packages/main/lib/TabContainer.js 528 B 0 B
packages/main/lib/TabContainerTabsPlacement.js 161 B 0 B
packages/main/lib/TabLayout.js 150 B 0 B
packages/main/lib/Table.js 620 B 0 B
packages/main/lib/TableCell.js 332 B 0 B
packages/main/lib/TableColumn.js 404 B 0 B
packages/main/lib/TablePlaceholder.js 771 B 0 B
packages/main/lib/TableRow.js 316 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/TabSeparator.js 340 B 0 B
packages/main/lib/Text.js 987 B 0 B
packages/main/lib/TextAlign.js 183 B 0 B
packages/main/lib/TextArea.js 653 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/Timeline.js 569 B 0 B
packages/main/lib/TimelineItem.js 356 B 0 B
packages/main/lib/TimePicker.js 544 B 0 B
packages/main/lib/Title.js 401 B 0 B
packages/main/lib/TitleLevel.js 163 B 0 B
packages/main/lib/Toast.js 420 B 0 B
packages/main/lib/ToastPlacement.js 208 B 0 B
packages/main/lib/ToggleButton.js 667 B 0 B
packages/main/lib/Token.js 383 B 0 B
packages/main/lib/Tokenizer.js 536 B 0 B
packages/main/lib/Toolbar.js 3.42 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/Tree.js 417 B 0 B
packages/main/lib/TreeItem.js 418 B 0 B
packages/main/lib/UploadCollection.js 470 B 0 B
packages/main/lib/UploadCollectionItem.js 466 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.75 kB 0 B

compressed-size-action

@coveralls
Copy link

coveralls commented Nov 11, 2020 •
edited
Loading

Coverage Status

Coverage remained the same at 65.418% when pulling f70f127 on docs/filter-bar into 7087886 on master.

@MarcusNotheis MarcusNotheis merged commit 94965de into master Nov 11, 2020
@MarcusNotheis MarcusNotheis deleted the docs/filter-bar branch November 11, 2020 18:29
@Lukas742 Lukas742 linked an issue Nov 12, 2020 that may be closed by this pull request
Add JSDoc comments to FilterBar and FilterGroupItem components #727
Closed
4 tasks
renovate bot added a commit that referenced this pull request Oct 28, 2024
@renovate
chore(deps): update all non-major dependencies (examples & templates)…
709bc01 
… (patch) (#6556)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [cypress](https://cypress.io)
([source](https://redirect.github.com/cypress-io/cypress)) | [`13.15.0`
-> `13.15.1`](https://renovatebot.com/diffs/npm/cypress/13.15.0/13.15.1)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/cypress/13.15.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/cypress/13.15.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/cypress/13.15.0/13.15.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/cypress/13.15.0/13.15.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[eslint-plugin-jsx-a11y](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y)
| [`6.10.1` ->
`6.10.2`](https://renovatebot.com/diffs/npm/eslint-plugin-jsx-a11y/6.10.1/6.10.2)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/eslint-plugin-jsx-a11y/6.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/eslint-plugin-jsx-a11y/6.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/eslint-plugin-jsx-a11y/6.10.1/6.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/eslint-plugin-jsx-a11y/6.10.1/6.10.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[eslint-plugin-react-refresh](https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh)
| [`0.4.13` ->
`0.4.14`](https://renovatebot.com/diffs/npm/eslint-plugin-react-refresh/0.4.13/0.4.14)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/eslint-plugin-react-refresh/0.4.14?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/eslint-plugin-react-refresh/0.4.14?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/eslint-plugin-react-refresh/0.4.13/0.4.14?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/eslint-plugin-react-refresh/0.4.13/0.4.14?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>cypress-io/cypress (cypress)</summary>

###
[`v13.15.1`](https://redirect.github.com/cypress-io/cypress/releases/tag/v13.15.1)

[Compare
Source](https://redirect.github.com/cypress-io/cypress/compare/v13.15.0...v13.15.1)

Changelog: https://docs.cypress.io/guides/references/changelog#13-15-1

</details>

<details>
<summary>jsx-eslint/eslint-plugin-jsx-a11y
(eslint-plugin-jsx-a11y)</summary>

###
[`v6.10.2`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/HEAD/CHANGELOG.md#v6102---2024-10-25)

[Compare
Source](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/compare/v6.10.1...v6.10.2)

##### Fixed

- \[patch] `no-redundandant-roles`: allow `&lt;img src="*.svg"
role="img" /&gt;`
[`#936`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues/936)

##### Commits

- \[meta] fix changelog URLs
[`0d01a1a`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/0d01a1aff796802bca70183b24978ffebdbef073)
- \[Refactor] remove no-longer-needed `es-iterator-helpers`
[`aa075bd`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/aa075bd1897e0b0bb61683e4da68558f38511dae)
- \[Refactor] avoid spreading things that are already arrays
[`d15d3ab`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/d15d3abace7afe833d0988eaf3fb7cc166c05c06)
- \[Dev Deps] update `@babel/cli`, `@babel/core`,
`@babel/eslint-parser`, `@babel/plugin-transform-flow-strip-types`,
`@babel/register`
[`5dad7c4`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/5dad7c4fdfdc56c6e488fab54f25f602430dad30)
- \[Tests] `aria-role`: Add valid test for `&lt;svg role="img" /&gt;`
[`daba189`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/daba18974473bce1301ffaafb822558a9e1738ae)
- \[Docs] `label-has-associated-control`: add line breaks for
readability
[`0bc6378`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/0bc63781c8f284ac6bef00321763c13c5bea6b9f)
- \[Tests] `label-has-associated-control`: add additional test cases
[`30d2318`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/30d23189d0b6354750c31a622204a9dc412dc2c1)
- \[Tests] Add tests to reinforce required attributes for role="heading"
[`d92446c`](https://redirect.github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/d92446c6e608617a4c75173e8b0917c06be14dc6)

</details>

<details>
<summary>ArnaudBarre/eslint-plugin-react-refresh
(eslint-plugin-react-refresh)</summary>

###
[`v0.4.14`](https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/HEAD/CHANGELOG.md#0414)

[Compare
Source](https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.4.13...v0.4.14)

- Warn if a context is exported alongside a component (fixes
[#&#8203;53](https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh/issues/53)).
Thanks [@&#8203;IgorAufricht](https://redirect.github.com/IgorAufricht)!

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 4am on Monday" (UTC),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config
help](https://redirect.github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/SAP/ui5-webcomponents-react).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xMjAuMSIsInVwZGF0ZWRJblZlciI6IjM4LjEyMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcusNotheis MarcusNotheis MarcusNotheis approved these changes

@vbersch vbersch Awaiting requested review from vbersch

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add JSDoc comments to FilterBar and FilterGroupItem components
3 participants
@Lukas742 @coveralls @MarcusNotheis