-
Notifications
You must be signed in to change notification settings - Fork 206
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
1,771 additions
and
1,709 deletions.
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
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
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,136 @@ | ||
| ## Description | ||
|
|
||
| `sp-tags` and `sp-tag` elements allow users to categorize content. They can represent keywords or people, and are grouped to describe an item or a search request. | ||
|
|
||
| ## To do: | ||
|
|
||
| Keyboard interactions | ||
|
|
||
| ### Installation | ||
|
|
||
| [](https://www.npmjs.com/package/@spectrum-web-components/tags) | ||
| [](https://bundlephobia.com/result?p=@spectrum-web-components/tags) | ||
|
|
||
| ``` | ||
| npm install @spectrum-web-components/tags | ||
| # or | ||
| yarn add @spectrum-web-components/tags | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| <sp-icons-medium></sp-icons-medium> | ||
|
|
||
| ```html-live | ||
| <sp-tags> | ||
| <sp-tag>Tag 1</sp-tag> | ||
| <sp-tag invalid>Tag 2</sp-tag> | ||
| <sp-tag disabled>Tag 3</sp-tag> | ||
| </sp-tags> | ||
| ``` | ||
|
|
||
| ```html-live | ||
| <sp-tags> | ||
| <sp-tag> | ||
| Tag 1 | ||
| <sp-avatar | ||
| slot="avatar" | ||
| label="Tag 1" | ||
| src=https://placedog.net/500/500 | ||
| ></sp-avatar> | ||
| </sp-tag> | ||
| <sp-tag invalid> | ||
| Tag 2 | ||
| <sp-avatar | ||
| slot="avatar" | ||
| label="Tag 1" | ||
| src=https://placedog.net/500/500 | ||
| ></sp-avatar> | ||
| </sp-tag> | ||
| <sp-tag disabled> | ||
| Tag 3 | ||
| <sp-avatar | ||
| slot="avatar" | ||
| label="Tag 1" | ||
| src=https://placedog.net/500/500 | ||
| ></sp-avatar> | ||
| </sp-tag> | ||
| </sp-tags> | ||
| ``` | ||
|
|
||
| ```html-live | ||
| <sp-tags> | ||
| <sp-tag> | ||
| Tag 1 | ||
| <sp-icon slot="icon" size="xs" name="ui:Magnifier"></sp-icon> | ||
| </sp-tag> | ||
| <sp-tag invalid> | ||
| Tag 2 | ||
| <sp-icon slot="icon" size="xs" name="ui:Magnifier"></sp-icon> | ||
| </sp-tag> | ||
| <sp-tag disabled> | ||
| Tag 3 | ||
| <sp-icon slot="icon" size="xs" name="ui:Magnifier"></sp-icon> | ||
| </sp-tag> | ||
| </sp-tags> | ||
| ``` | ||
|
|
||
| ### Deletable | ||
|
|
||
| Use the `deletable` attribute to signify `sp-tags` elements that can be removed. | ||
|
|
||
| ```html-live | ||
| <sp-tags> | ||
| <sp-tag deletable>Tag 1</sp-tag> | ||
| <sp-tag invalid deletable>Tag 2</sp-tag> | ||
| <sp-tag disabled deletable>Tag 3</sp-tag> | ||
| </sp-tags> | ||
| ``` | ||
|
|
||
| ```html-live | ||
| <sp-tags> | ||
| <sp-tag deletable> | ||
| Tag 1 | ||
| <sp-avatar | ||
| slot="avatar" | ||
| label="Tag 1" | ||
| src=https://placedog.net/500/500 | ||
| ></sp-avatar> | ||
| </sp-tag> | ||
| <sp-tag invalid deletable> | ||
| Tag 2 | ||
| <sp-avatar | ||
| slot="avatar" | ||
| label="Tag 1" | ||
| src=https://placedog.net/500/500 | ||
| ></sp-avatar> | ||
| </sp-tag> | ||
| <sp-tag disabled deletable> | ||
| Tag 3 | ||
| <sp-avatar | ||
| slot="avatar" | ||
| label="Tag 1" | ||
| src=https://placedog.net/500/500 | ||
| ></sp-avatar> | ||
| </sp-tag> | ||
| </sp-tags> | ||
| ``` | ||
|
|
||
| ```html-live | ||
| <sp-tags> | ||
| <sp-tag deletable> | ||
| Tag 1 | ||
| <sp-icon slot="icon" size="xs" name="ui:Magnifier"></sp-icon> | ||
| </sp-tag> | ||
| <sp-tag invalid deletable> | ||
| Tag 2 | ||
| <sp-icon slot="icon" size="xs" name="ui:Magnifier"></sp-icon> | ||
| </sp-tag> | ||
| <sp-tag disabled deletable> | ||
| Tag 3 | ||
| <sp-icon slot="icon" size="xs" name="ui:Magnifier"></sp-icon> | ||
| </sp-tag> | ||
| </sp-tags> | ||
| ``` |
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,48 @@ | ||
| { | ||
| "name": "@spectrum-web-components/tags", | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/adobe/spectrum-web-components.git", | ||
| "directory": "packages/tags" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/adobe/spectrum-web-components/issues" | ||
| }, | ||
| "homepage": "https://adobe.github.io/spectrum-web-components/components/tags", | ||
| "keywords": [ | ||
| "spectrum css", | ||
| "web components", | ||
| "lit-element", | ||
| "lit-html" | ||
| ], | ||
| "version": "0.0.1", | ||
| "description": "", | ||
| "main": "lib/index.js", | ||
| "module": "lib/index.js", | ||
| "type": "module", | ||
| "files": [ | ||
| "custom-elements.json", | ||
| "/lib/", | ||
| "/src/" | ||
| ], | ||
| "scripts": { | ||
| "test": "karma start --coverage" | ||
| }, | ||
| "author": "", | ||
| "license": "Apache-2.0", | ||
| "peerDependencies": { | ||
| "lit-element": "^2.1.0", | ||
| "lit-html": "^1.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@spectrum-css/tags": "^2.0.0" | ||
| }, | ||
| "dependencies": { | ||
| "@spectrum-web-components/button": "^0.5.1", | ||
| "@spectrum-web-components/shared": "^0.4.6", | ||
| "tslib": "^1.10.0" | ||
| } | ||
| } |
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,33 @@ | ||
| /* | ||
| Copyright 2020 Adobe. All rights reserved. | ||
| This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. You may obtain a copy | ||
| of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software distributed under | ||
| the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| OF ANY KIND, either express or implied. See the License for the specific language | ||
| governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| export * from './tags.js'; | ||
| export * from './tag.js'; | ||
|
|
||
| import { Tags } from './tags.js'; | ||
| import { Tag } from './tag.js'; | ||
|
|
||
| /* istanbul ignore else */ | ||
| if (!customElements.get('sp-tags')) { | ||
| customElements.define('sp-tags', Tags); | ||
| } | ||
| /* istanbul ignore else */ | ||
| if (!customElements.get('sp-tag')) { | ||
| customElements.define('sp-tag', Tag); | ||
| } | ||
|
|
||
| declare global { | ||
| interface HTMLElementTagNameMap { | ||
| 'sp-tags': Tags; | ||
| 'sp-tag': Tag; | ||
| } | ||
| } |
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,71 @@ | ||
| /* | ||
| Copyright 2020 Adobe. All rights reserved. | ||
| This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. You may obtain a copy | ||
| of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software distributed under | ||
| the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| OF ANY KIND, either express or implied. See the License for the specific language | ||
| governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| module.exports = { | ||
| spectrum: 'tags', | ||
| components: [ | ||
| { | ||
| name: 'tags', | ||
| host: { | ||
| selector: '.spectrum-Tags', | ||
| }, | ||
| exclude: [/\.spectrum-Tags-item/], | ||
| }, | ||
| { | ||
| name: 'tag', | ||
| host: { | ||
| selector: '.spectrum-Tags-item', | ||
| }, | ||
| attributes: [ | ||
| { | ||
| selector: '.is-disabled', | ||
| type: 'boolean', | ||
| name: 'disabled', | ||
| }, | ||
| { | ||
| selector: '.is-invalid', | ||
| type: 'boolean', | ||
| name: 'invalid', | ||
| }, | ||
| { | ||
| selector: '.spectrum-Tags-item--deletable', | ||
| type: 'boolean', | ||
| name: 'deletable', | ||
| }, | ||
| ], | ||
| classes: [ | ||
| { | ||
| selector: '.spectrum-ClearButton', | ||
| name: 'clear-button', | ||
| }, | ||
| { | ||
| selector: '.spectrum-Tags-itemLabel', | ||
| name: 'label', | ||
| }, | ||
| ], | ||
| slots: [ | ||
| { | ||
| selector: '.spectrum-Avatar', | ||
| name: 'avatar', | ||
| }, | ||
| { | ||
| selector: '.spectrum-Icon', | ||
| name: 'icon', | ||
| }, | ||
| ], | ||
| exclude: [ | ||
| /\.spectrum-Tags /, | ||
| /\.spectrum-ClearButton \.spectrum-Icon/, | ||
| ], | ||
| }, | ||
| ], | ||
| }; |
Oops, something went wrong.