-
Notifications
You must be signed in to change notification settings - Fork 109
feat(ui-drilldown,ui-options,ui): rework Drilldown #2469
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
Open
ToMESSKa
wants to merge
1
commit into
master
Choose a base branch
from
INSTUI-4792-drilldown-rework-multi
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+4,355
−162
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
packages/ui-drilldown/src/Drilldown/v2/DrilldownGroup/index.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2015 - present Instructure, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import { Component } from 'react' | ||
|
|
||
| import { withStyle } from '@instructure/emotion' | ||
|
|
||
| import { allowedProps } from './props' | ||
| import type { DrilldownGroupProps } from './props' | ||
| import { isMac, isFirefox } from '@instructure/ui-utils' | ||
|
|
||
| /** | ||
| --- | ||
| parent: Drilldown | ||
| id: Drilldown.Group | ||
| themeId: Options | ||
| --- | ||
| @module DrilldownGroup | ||
| **/ | ||
| // needed for listing the available theme variables on docs page, | ||
| // we pass the themeOverrides to Options | ||
| @withStyle(null) | ||
| class DrilldownGroup extends Component<DrilldownGroupProps> { | ||
| static readonly componentId = 'Drilldown.Group' | ||
|
|
||
| static allowedProps = allowedProps | ||
| static defaultProps = { | ||
| disabled: false, | ||
| withoutSeparators: false, | ||
| // Firefox with NVDA does not read Drilldown.Group with role="group" correctly | ||
| // but setting role="menu" on all other platforms results in Drilldown.Group label not being read | ||
| role: !isMac() && isFirefox() ? 'menu' : 'group' | ||
| } | ||
|
|
||
| render() { | ||
| // this component is only used for prop validation. | ||
| // Drilldown.Group is parsed in Drilldown as an Options component. | ||
| return null | ||
| } | ||
| } | ||
|
|
||
| export default DrilldownGroup | ||
| export { DrilldownGroup } |
134 changes: 134 additions & 0 deletions
134
packages/ui-drilldown/src/Drilldown/v2/DrilldownGroup/props.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2015 - present Instructure, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import React from 'react' | ||
|
|
||
| import type { | ||
| OtherHTMLAttributes, | ||
| OptionsTheme, | ||
| AsElementType | ||
| } from '@instructure/shared-types' | ||
| import type { WithStyleProps } from '@instructure/emotion' | ||
|
|
||
| import Drilldown from '../index' | ||
| import type { DrilldownOptionValue } from '../DrilldownOption/props' | ||
| import type { OptionChild, SeparatorChild } from '../props' | ||
|
|
||
| type GroupChildren = OptionChild | SeparatorChild | ||
|
|
||
| type DrilldownGroupOwnProps = { | ||
| id: string | ||
|
|
||
| /** | ||
| * Children of type: | ||
| * `<Drilldown.Option />`, `<Drilldown.Separator />` | ||
| */ | ||
| children?: GroupChildren | GroupChildren[] // TODO: type Children.oneOf([DrilldownOption, DrilldownSeparator]) | ||
|
|
||
| /** | ||
| * The label of the option group. | ||
| */ | ||
| renderGroupTitle?: React.ReactNode | (() => React.ReactNode) | ||
|
|
||
| /** | ||
| * Hides the separators around the group. | ||
| */ | ||
| withoutSeparators?: boolean | ||
|
|
||
| /** | ||
| * Is the option group disabled. | ||
| */ | ||
| disabled?: boolean | ||
|
|
||
| /** | ||
| * The ARIA role of the element. | ||
| */ | ||
| role?: string | ||
|
|
||
| /** | ||
| * Element type to render as. By default, it inherits Drilldown's `as` prop. | ||
| */ | ||
| as?: AsElementType | ||
|
|
||
| /** | ||
| * Provides a reference to the underlying html root element | ||
| */ | ||
| elementRef?: (element: Element | null) => void | ||
|
|
||
| // selection props | ||
| /** | ||
| * Makes the option group selectable (with "check" icon indicators). | ||
| * Can be set to a single-select (radio) or a multi-select (checkbox) group. | ||
| */ | ||
| selectableType?: 'single' | 'multiple' | ||
|
|
||
| /** | ||
| * An array of the values for the selected items on initial render. Works only with "selectableType" set. If "selectableType" is "single", the array has to have 1 item. | ||
| */ | ||
| defaultSelected?: DrilldownOptionValue[] | ||
|
|
||
| /** | ||
| * An array of the values for the selected items. If defined, the component will act controlled and will not manage its own state. Works only with "selectableType" set. | ||
| * If "selectableType" is "single", the array has to have 1 item. | ||
| */ | ||
| selectedOptions?: DrilldownOptionValue[] | ||
|
|
||
| /** | ||
| * Callback fired when an option within the `<Drilldown.Group />` is selected | ||
| */ | ||
| onSelect?: ( | ||
| event: React.SyntheticEvent, | ||
| args: { | ||
| value: DrilldownOptionValue[] | ||
| isSelected: boolean | ||
| selectedOption: OptionChild | ||
| drilldown: Drilldown | ||
| } | ||
| ) => void | ||
| } | ||
|
|
||
| type PropKeys = keyof DrilldownGroupOwnProps | ||
|
|
||
| type AllowedPropKeys = Readonly<Array<PropKeys>> | ||
|
|
||
| type DrilldownGroupProps = DrilldownGroupOwnProps & | ||
| WithStyleProps<OptionsTheme, null> & | ||
| OtherHTMLAttributes<DrilldownGroupOwnProps> | ||
| const allowedProps: AllowedPropKeys = [ | ||
| 'id', | ||
| 'children', | ||
| 'renderGroupTitle', | ||
| 'withoutSeparators', | ||
| 'disabled', | ||
| 'role', | ||
| 'as', | ||
| 'elementRef', | ||
| 'selectableType', | ||
| 'defaultSelected', | ||
| 'selectedOptions', | ||
| 'onSelect' | ||
| ] | ||
|
|
||
| export type { DrilldownGroupProps, GroupChildren } | ||
| export { allowedProps } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Drilldown displays the token of Options in some of its subcomponents, so I implemented this functionality without the theme.ts files like in v11_6