This repository has been archived by the owner on May 24, 2024. It is now read-only.
[terra-tag] Create tag-list subcomponent #3854
+1,930
−23
There are no files selected for viewing
This file contains 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 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
File renamed without changes.
This file contains 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,55 @@ | ||
| import { Badge } from 'terra-tag/package.json?dev-site-package'; | ||
|
|
||
| import TagListCollapsed from './example/TagListCollapsed?dev-site-example'; | ||
|
|
||
| import TagListSmall from './example/TagListSmall?dev-site-example'; | ||
|
|
||
| import TagPropsTable from 'terra-tag/lib/TagList?dev-site-props-table'; | ||
|
|
||
| <Badge /> | ||
|
|
||
| # Terra Tag List | ||
|
|
||
| The Tag List is a subcomponent of main component `tag` which is used for grouping tabs together in a list to enable keyboard navigation using arrow keys. Navigation from one list to another can be done using `tab` key and within the list, navigation can be done using arrow keys, `right key` to move to next tag and `left key` to move to previous tag. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - Install with [npmjs](https://www.npmjs.com): | ||
| - `npm install terra-tag-list` | ||
|
|
||
| <!-- AUTO-GENERATED-CONTENT:START Peer Dependencies --> | ||
| ## Peer Dependencies | ||
|
|
||
| This component requires the following peer dependencies be installed in your app for the component to properly function. | ||
|
|
||
| | Peer Dependency | Version | | ||
| |-|-| | ||
| | react | ^16.8.5 | | ||
| | react-dom | ^16.8.5 | | ||
| | react-intl | ^2.8.0 | | ||
|
|
||
| <!-- AUTO-GENERATED-CONTENT:END --> | ||
|
There was a problem hiding this comment. we might need to add implementation details on both tag and taglist about page similar to this There was a problem hiding this comment. |
||
|
|
||
| ## Implementation Notes: | ||
| The Switch component must be composed inside the [Base][1] component with a locale in order for it to load the correct translation strings. | ||
|
|
||
| [1]: https://engineering.cerner.com/terra-ui/application/terra-application/components/application-base | ||
|
|
||
| ## Usage | ||
| ```jsx | ||
| import { TagList } from 'terra-tag'; | ||
| ``` | ||
|
|
||
| ## Component Features | ||
|
|
||
| * [Cross-Browser Support](https://engineering.cerner.com/terra-ui/about/terra-ui/component-standards#cross-browser-support) | ||
| * [Responsive Support](https://engineering.cerner.com/terra-ui/about/terra-ui/component-standards#responsive-support) | ||
| * [Mobile Support](https://engineering.cerner.com/terra-ui/about/terra-ui/component-standards#mobile-support) | ||
|
|
||
| ## Examples | ||
| <TagListCollapsed title="Tag List Collapsed" /> | ||
|
|
||
| <TagListSmall title="Tag List Small" /> | ||
|
|
||
| ## Tag Props | ||
| <TagPropsTable /> | ||
File renamed without changes.
This file contains 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,120 @@ | ||
| // Themes | ||
| @import '../../../theme/clinical-lowlight-theme/FilterTags.module'; | ||
| @import '../../../theme/orion-fusion-theme/FilterTags.module'; | ||
|
|
||
| :local { | ||
| // Terra Docs Example Reset Button | ||
| .terra-docs-example-reset-button { | ||
| margin-bottom: var(--terra-core-docs-example-reset-button-margin-bottom, -2.42857rem); | ||
| margin-top: 1.42857rem; | ||
| position: relative; | ||
|
|
||
| &.is-disabled { | ||
| cursor: default; | ||
| opacity: 0.3; | ||
| pointer-events: none; | ||
| } | ||
| } | ||
|
|
||
| // Applied Filters Toolbar Example | ||
| .terra-filter-tags-doc-example-applied-filters { | ||
| border: var(--terra-core-docs-filter-tags-doc-example-applied-filters-border, 1px solid #d3d4d5); | ||
| margin: 0; | ||
| padding: 0; | ||
|
|
||
| .applied-filters-content-panel { | ||
| background-color: var(--terra-core-docs-filter-tags-doc-example-applied-filters-content-panel-background-color, #f4f4f4); | ||
| margin: 0; | ||
| padding: var(--terra-core-docs-filter-tags-doc-example-applied-filters-content-panel-padding, 0); | ||
| } | ||
|
|
||
| .applied-filters-label { | ||
| color: var(--terra-core-docs-filter-tags-doc-example-applied-filters-label-color, #4d5153); | ||
| display: inline-block; | ||
| font-size: var(--terra-core-docs-filter-tags-doc-example-applied-filters-label-font-size, 0.92857rem); | ||
| font-weight: var(--terra-core-docs-filter-tags-doc-example-applied-filters-label-font-weight, 400); | ||
| vertical-align: top; | ||
| } | ||
| } | ||
|
|
||
| .terra-filter-tags-doc-example-applied-filters-toolbar { | ||
| padding-bottom: var(--terra-core-docs-filter-tags-doc-example-applied-filters-toolbar-padding-bottom, 0.42857rem); | ||
| padding-left: var(--terra-core-docs-filter-tags-doc-example-applied-filters-toolbar-padding-left, 0.71429rem); | ||
| padding-right: var(--terra-core-docs-filter-tags-doc-example-applied-filters-toolbar-padding-right, 0.35714rem); | ||
| padding-top: var(--terra-core-docs-filter-tags-doc-example-applied-filters-toolbar-padding-top, 0.42857rem); | ||
|
|
||
| > [class*='Toolbar-module__item___'] { | ||
| display: block; | ||
| margin: 0; | ||
| padding: 0; | ||
| width: 100%; | ||
| } | ||
|
|
||
| .toolbar-flex-container { | ||
| display: flex; | ||
| margin: 0; | ||
| min-width: 100%; | ||
| padding: 0; | ||
| width: 100%; | ||
| } | ||
|
|
||
| .toolbar-flex-item-start, | ||
| .toolbar-flex-item-fill, | ||
| .toolbar-flex-item-end { | ||
| margin: 0; | ||
| padding: 0; | ||
| } | ||
|
|
||
| .toolbar-flex-item-start { | ||
| flex: 0 0 auto; | ||
| margin-right: var(--terra-core-docs-filter-tags-doc-example-applied-filters-flex-item-start-margin-right, 0.57143rem); | ||
| padding-top: var(--terra-core-docs-filter-tags-doc-example-applied-filters-flex-item-start-padding-top, 0.5rem); | ||
| vertical-align: top; | ||
| } | ||
|
|
||
| .toolbar-flex-item-fill { | ||
| flex: 1 1 auto; | ||
| min-width: 3rem; | ||
| vertical-align: top; | ||
| } | ||
|
|
||
| .toolbar-flex-item-end { | ||
| flex: 0 0 auto; | ||
| margin-left: var(--terra-core-docs-filter-tags-doc-example-applied-filters-flex-item-end-margin-left, 0); | ||
| padding-top: var(--terra-core-docs-filter-tags-doc-example-applied-filters-flex-item-end-padding-top, 0.10714rem); | ||
| vertical-align: top; | ||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
||
| // Truncated Label Example | ||
| .terra-filter-tags-doc-example-truncated-label-container { | ||
| background-color: var(--terra-core-docs-filter-tags-doc-example-truncated-label-container-background-color, #f4f4f4); | ||
| border: var(--terra-core-docs-filter-tags-doc-example-truncated-label-container-border, 2px dashed #d1d1d1); | ||
| border-bottom: 0 none; | ||
| border-top: 0 none; | ||
| box-sizing: content-box; | ||
| max-width: 20rem; | ||
| min-height: var(--terra-core-docs-filter-tags-doc-example-truncated-label-container-min-height, 2.28571rem); | ||
| padding: var(--terra-core-docs-filter-tags-doc-example-truncated-label-container-padding, 0.71428rem 0.21428rem 0.71428rem 0.21428rem); | ||
| width: 100%; | ||
| } | ||
|
|
||
| // Search Terms Example (has Visible Label) | ||
| .terra-filter-tags-doc-example-search-terms { | ||
| background-color: var(--terra-core-docs-filter-tags-doc-example-search-terms-background-color, #ecf3ff); | ||
| box-sizing: border-box; | ||
| min-height: var(--terra-core-docs-filter-tags-doc-example-search-terms-min-height, 7.5rem); | ||
| padding: var(--terra-core-docs-filter-tags-doc-example-search-terms-padding, 0.71428rem 0.85714rem); | ||
|
|
||
| .search-terms-label { | ||
| color: var(--terra-core-docs-filter-tags-doc-example-search-terms-label-color, #1a2f4b); | ||
| display: block; | ||
| font-size: var(--terra-core-docs-filter-tags-doc-example-search-terms-label-font-size, 1.07142rem); | ||
| font-weight: var(--terra-core-docs-filter-tags-doc-example-search-terms-label-font-weight, 500); | ||
| padding-bottom: var(--terra-core-docs-filter-tags-doc-example-search-terms-label-padding-bottom, 0.21428rem); | ||
| padding-left: var(--terra-core-docs-filter-tags-doc-example-search-terms-label-padding-left, 0.14285rem); | ||
| } | ||
| } | ||
| } |
This file contains 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,47 @@ | ||
| /* eslint-disable no-alert */ | ||
| import React from 'react'; | ||
| import IconPerson from 'terra-icon/lib/icon/IconPerson'; | ||
| import IconBookmark from 'terra-icon/lib/icon/IconTile'; | ||
| import Tag, { TagList } from 'terra-tag'; | ||
| import ThemeContext from 'terra-theme-context'; | ||
| import classNamesBind from 'classnames/bind'; | ||
| import Toolbar from 'terra-toolbar'; | ||
| import styles from './FilterTagsCommon.module.scss'; | ||
|
|
||
| const cx = classNamesBind.bind(styles); | ||
|
|
||
| const text = 'At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores '; | ||
|
|
||
| const TagListCollapsed = () => { | ||
| const theme = React.useContext(ThemeContext); | ||
|
|
||
| return ( | ||
| <> | ||
| <div className={cx(['terra-filter-tags-doc-example-applied-filters', theme.className])}> | ||
| <Toolbar className={cx('terra-filter-tags-doc-example-applied-filters-toolbar')}> | ||
| <div className={cx('toolbar-flex-container')}> | ||
| <div className={cx('toolbar-flex-item-start')} /> | ||
| <div className={cx('toolbar-flex-item-fill')}> | ||
| <TagList isCollapsible ariaLabel="Collapsible Tag List Example with collapsed list items"> | ||
| <Tag icon={<IconPerson />} text="Asthma" onClick={() => window.alert('Patient is diagnosed with asthma')} id="asthma" /> | ||
| <Tag icon={<IconBookmark />} text={text} id="longTextIcon" onClick={() => window.alert('Tag has been clicked!')} /> | ||
| <Tag id="bronchitis" text="Bronchitis" onClick={() => window.alert('Patient is diagnosed with bronchitis')} /> | ||
| <Tag id="fibro" text="Fibro" onClick={() => window.alert('Patient is diagnosed with Fibro')} /> | ||
| <Tag icon={<IconPerson />} text="Dust Allergy" onClick={() => window.alert('Patient is diagnosed with dust allergy')} id="allergy" /> | ||
| <Tag icon={<IconPerson />} text="Diabetes" onClick={() => window.alert('Patient is diagnosed with Diabetes')} id="diabetes" /> | ||
| <Tag text="Arthritis" onClick={() => window.alert('Patient is diagnosed with Arthritis')} id="arthritis" /> | ||
| <Tag text="Hypertension" onClick={() => window.alert('Patient is diagnosed with Hypertension (High Blood Pressure)')} id="hypertension" /> | ||
| <Tag icon={<IconPerson />} text="Multiple Sclerosis (MS)" onClick={() => window.alert('Patient is diagnosed with Multiple Sclerosis (MS)')} id="sclerosis" /> | ||
| <Tag text="Psoriasis" onClick={() => window.alert('Patient is diagnosed with Psoriasis')} id="psoriasis" /> | ||
| <Tag icon={<IconBookmark />} text="Epilepsy" onClick={() => window.alert('Patient is diagnosed with Epilepsy')} id="epilepsy" /> | ||
| <Tag icon={<IconPerson />} text="Ulcerative Colitis" onClick={() => window.alert('Patient is diagnosed with Ulcerative Colitis')} id="ulcer" /> | ||
| </TagList> | ||
| </div> | ||
| </div> | ||
| </Toolbar> | ||
| </div> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default TagListCollapsed; |
This file contains 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,34 @@ | ||
| /* eslint-disable no-alert */ | ||
| import React from 'react'; | ||
| import IconPerson from 'terra-icon/lib/icon/IconPerson'; | ||
| import Tag, { TagList } from 'terra-tag'; | ||
| import ThemeContext from 'terra-theme-context'; | ||
| import classNamesBind from 'classnames/bind'; | ||
| import Toolbar from 'terra-toolbar'; | ||
| import styles from './FilterTagsCommon.module.scss'; | ||
|
|
||
| const cx = classNamesBind.bind(styles); | ||
|
|
||
| const TagListSmall = () => { | ||
| const theme = React.useContext(ThemeContext); | ||
|
|
||
| return ( | ||
| <> | ||
| <div className={cx(['terra-filter-tags-doc-example-applied-filters', theme.className])}> | ||
| <Toolbar className={cx('terra-filter-tags-doc-example-applied-filters-toolbar')}> | ||
| <div className={cx('toolbar-flex-container')}> | ||
| <div className={cx('toolbar-flex-item-start')} /> | ||
| <div className={cx('toolbar-flex-item-fill')}> | ||
| <TagList isCollapsible ariaLabel="Tag List Example with small list"> | ||
| <Tag href="https://www.google.com/search?q=Asthma" text="Asthma" id="asthmaLink" /> | ||
| <Tag icon={<IconPerson />} href="https://www.google.com/search?q=Bronchitis" text="Bronchitis" id="BronchitisLink" /> | ||
| </TagList> | ||
| </div> | ||
| </div> | ||
| </Toolbar> | ||
| </div> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default TagListSmall; |
This file contains 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,46 @@ | ||
| /* eslint-disable no-alert */ | ||
| import React from 'react'; | ||
| import { IconBookmark, IconPerson } from 'terra-icon'; | ||
| import Tag, { TagList } from 'terra-tag'; | ||
| import ThemeContext from 'terra-theme-context'; | ||
| import classNamesBind from 'classnames/bind'; | ||
| import Toolbar from 'terra-toolbar'; | ||
| import styles from '../../doc/tag/example/FilterTagsCommon.module.scss'; | ||
|
|
||
| const cx = classNamesBind.bind(styles); | ||
|
|
||
| const text = 'At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores '; | ||
|
|
||
| const TagListCollapsedTags = () => { | ||
| const theme = React.useContext(ThemeContext); | ||
|
|
||
| return ( | ||
| <> | ||
| <div className={cx(['terra-filter-tags-doc-example-applied-filters', theme.className])}> | ||
| <Toolbar className={cx('terra-filter-tags-doc-example-applied-filters-toolbar')}> | ||
| <div className={cx('toolbar-flex-container')}> | ||
| <div className={cx('toolbar-flex-item-start')} /> | ||
| <div className={cx('toolbar-flex-item-fill')}> | ||
| <TagList isCollapsible ariaLabel="Collapsible Tag List Example with collapsed list items"> | ||
| <Tag icon={<IconPerson />} text="Asthma" onClick={() => window.alert('Patient is diagnosed with asthma')} id="asthma" /> | ||
| <Tag icon={<IconBookmark />} text={text} id="longTextIcon" onClick={() => window.alert('Tag has been clicked!')} /> | ||
| <Tag id="bronchitis" text="Bronchitis" onClick={() => window.alert('Patient is diagnosed with bronchitis')} /> | ||
| <Tag id="fibro" text="Fibro" onClick={() => window.alert('Patient is diagnosed with Fibro')} /> | ||
| <Tag icon={<IconPerson />} text="Dust Allergy" onClick={() => window.alert('Patient is diagnosed with dust allergy')} id="allergy" /> | ||
| <Tag icon={<IconPerson />} text="Diabetes" onClick={() => window.alert('Patient is diagnosed with Diabetes')} id="diabetes" /> | ||
| <Tag text="Arthritis" onClick={() => window.alert('Patient is diagnosed with Arthritis')} id="arthritis" /> | ||
| <Tag text="Hypertension" onClick={() => window.alert('Patient is diagnosed with Hypertension (High Blood Pressure)')} id="hypertension" /> | ||
| <Tag icon={<IconPerson />} text="Multiple Sclerosis (MS)" onClick={() => window.alert('Patient is diagnosed with Multiple Sclerosis (MS)')} id="sclerosis" /> | ||
| <Tag text="Psoriasis" onClick={() => window.alert('Patient is diagnosed with Psoriasis')} id="psoriasis" /> | ||
| <Tag icon={<IconBookmark />} text="Epilepsy" onClick={() => window.alert('Patient is diagnosed with Epilepsy')} id="epilepsy" /> | ||
| <Tag icon={<IconPerson />} text="Ulcerative Colitis" onClick={() => window.alert('Patient is diagnosed with Ulcerative Colitis')} id="ulcer" /> | ||
| </TagList> | ||
| </div> | ||
| </div> | ||
| </Toolbar> | ||
| </div> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| export default TagListCollapsedTags; |
This file contains 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,42 @@ | ||
| :local { | ||
| .clinical-lowlight-theme { | ||
| /* ---------------------------------------------------------------------- * | ||
| * Filter Pills: Doc Examples | ||
| * ---------------------------------------------------------------------- */ | ||
|
|
||
| // Terra Docs Example Reset Button | ||
| --terra-core-docs-example-reset-button-margin-bottom: -2.42857rem; | ||
|
|
||
| // Applied Filters Toolbar Example | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-border: 1px solid #181b1d; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-content-panel-background-color: #1c1f21; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-content-panel-padding: 0; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-label-color: #b2b5b6; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-label-font-size: 0.92857rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-label-font-weight: 400; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-toolbar-padding-bottom: 0.42857rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-toolbar-padding-left: 0.71429rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-toolbar-padding-right: 0.35714rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-toolbar-padding-top: 0.42857rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-flex-item-start-margin-right: 0.57143rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-flex-item-start-padding-top: 0.5rem; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-flex-item-end-margin-left: 0; | ||
| --terra-core-docs-filter-pills-doc-example-applied-filters-flex-item-end-padding-top: 0.10714rem; | ||
|
|
||
| // Truncated Label Example | ||
| --terra-core-docs-filter-pills-doc-example-truncated-label-container-background-color: rgba(224, 215, 16, 0.1); | ||
| --terra-core-docs-filter-pills-doc-example-truncated-label-container-border: 2px dashed #e0d710; | ||
| --terra-core-docs-filter-pills-doc-example-truncated-label-container-min-height: 2.28571rem; | ||
| --terra-core-docs-filter-pills-doc-example-truncated-label-container-padding: 0.71428rem 0.21428rem 0.71428rem 0.21428rem; | ||
|
|
||
| // Search Terms Example (has Visible Label) | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-background-color: #2d3539; | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-min-height: 7.5rem; | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-padding: 0.71428rem 0.85714rem; | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-label-color: rgb(234, 236, 239); | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-label-font-size: 1.07142rem; | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-label-font-weight: 500; | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-label-padding-bottom: 0.21428rem; | ||
| --terra-core-docs-filter-pills-doc-example-search-terms-label-padding-left: 0.14285rem; | ||
| } | ||
| } |
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.
Can we add React-Intl as a peer dependency in both Tag About page and here as well
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.
Updated :) 8ded50f#diff-43d71167fbce146e41d65538d63d237642369f5d98c53c55d8294d764b82ddfb