-
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.
feat(field-group): add field-group pattern
- Loading branch information
Showing
25 changed files
with
462 additions
and
48 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
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,48 @@ | ||
| ## Description | ||
|
|
||
| An `<sp-field-group>` element is used to layout a group of fields, usually `<sp-checkbox>` elements. It can be leveraged for `vertical` or `horizontal` organization of the fields that are supplied as its children. | ||
|
|
||
| ### Usage | ||
|
|
||
| [](https://www.npmjs.com/package/@spectrum-web-components/field-group) | ||
| [](https://bundlephobia.com/result?p=@spectrum-web-components/field-group) | ||
|
|
||
| ``` | ||
| yarn add @spectrum-web-components/field-group | ||
| ``` | ||
|
|
||
| Import the side effectful registration of `<sp-field-group>` via: | ||
|
|
||
| ``` | ||
| import '@spectrum-web-components/field-group/sp-field-group.js'; | ||
| ``` | ||
|
|
||
| When looking to leverage the `FieldGroup` base class as a type and/or for extension purposes, do so via: | ||
|
|
||
| ``` | ||
| import { FieldGroup } from '@spectrum-web-components/field-group'; | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| ```html | ||
| <sp-field-group horizontal> | ||
| <sp-checkbox>Checkbox 1</sp-checkbox> | ||
| <sp-checkbox>Checkbox 2</sp-checkbox> | ||
| <sp-checkbox checked>Checkbox 3</sp-checkbox> | ||
| <sp-checkbox>Checkbox 4</sp-checkbox> | ||
| <sp-checkbox>Checkbox 5</sp-checkbox> | ||
| </sp-field-group> | ||
| ``` | ||
|
|
||
| ### Vertical | ||
|
|
||
| ```html | ||
| <sp-field-group vertical> | ||
| <sp-checkbox>Checkbox 1</sp-checkbox> | ||
| <sp-checkbox>Checkbox 2</sp-checkbox> | ||
| <sp-checkbox>Checkbox 3</sp-checkbox> | ||
| <sp-checkbox>Checkbox 4</sp-checkbox> | ||
| <sp-checkbox checked>Checkbox 5</sp-checkbox> | ||
| </sp-field-group> | ||
| ``` |
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,59 @@ | ||
| { | ||
| "name": "@spectrum-web-components/field-group", | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/adobe/spectrum-web-components.git", | ||
| "directory": "packages/field-group" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/adobe/spectrum-web-components/issues" | ||
| }, | ||
| "homepage": "https://adobe.github.io/spectrum-web-components/components/field-group", | ||
| "keywords": [ | ||
| "spectrum css", | ||
| "web components", | ||
| "lit-element", | ||
| "lit-html" | ||
| ], | ||
| "version": "0.0.1", | ||
| "description": "", | ||
| "main": "src/index.js", | ||
| "module": "src/index.js", | ||
| "type": "module", | ||
| "exports": { | ||
| "./": "./src/index.js", | ||
| "./src/": "./src/", | ||
| "./custom-elements.json": "./custom-elements.json", | ||
| "./package.json": "./package.json", | ||
| "./sp-field-group": "./sp-field-group.js", | ||
| "./sp-field-group.js": "./sp-field-group.js" | ||
| }, | ||
| "files": [ | ||
| "custom-elements.json", | ||
| "*.d.ts", | ||
| "*.js", | ||
| "*.js.map", | ||
| "/src/" | ||
| ], | ||
| "sideEffects": [ | ||
| "./sp-*.js", | ||
| "./sp-*.ts" | ||
| ], | ||
| "scripts": { | ||
| "test": "echo \"Error: run tests from mono-repo root.\" && exit 1" | ||
| }, | ||
| "author": "", | ||
| "license": "Apache-2.0", | ||
| "devDependencies": { | ||
| "@spectrum-css/fieldgroup": "^3.0.0-beta.4", | ||
| "@spectrum-web-components/checkbox": "^0.5.2", | ||
| "@spectrum-web-components/radio": "^0.4.4" | ||
| }, | ||
| "dependencies": { | ||
| "@spectrum-web-components/base": "^0.1.3", | ||
| "tslib": "^2.0.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,21 @@ | ||
| /* | ||
| 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. | ||
| */ | ||
|
|
||
| import { FieldGroup } from './src/FieldGroup.js'; | ||
|
|
||
| customElements.define('sp-field-group', FieldGroup); | ||
|
|
||
| declare global { | ||
| interface HTMLElementTagNameMap { | ||
| 'sp-field-group': FieldGroup; | ||
| } | ||
| } |
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 @@ | ||
| /* | ||
| 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. | ||
| */ | ||
|
|
||
| import { | ||
| html, | ||
| SpectrumElement, | ||
| CSSResultArray, | ||
| TemplateResult, | ||
| property, | ||
| } from '@spectrum-web-components/base'; | ||
|
|
||
| import styles from './field-group.css.js'; | ||
|
|
||
| /** | ||
| * @element sp-field-group | ||
| */ | ||
| export class FieldGroup extends SpectrumElement { | ||
| public static get styles(): CSSResultArray { | ||
| return [styles]; | ||
| } | ||
|
|
||
| @property({ type: Boolean, reflect: true }) | ||
| public horizontal = false; | ||
|
|
||
| @property({ type: Boolean, reflect: true }) | ||
| public vertical = false; | ||
|
|
||
| protected render(): TemplateResult { | ||
| return html` | ||
| <slot></slot> | ||
| `; | ||
| } | ||
| } |
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,25 @@ | ||
| /* | ||
| 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. | ||
| */ | ||
|
|
||
| @import './spectrum-field-group.css'; | ||
|
|
||
| :host([horizontal][dir='rtl']) ::slotted(*:not(:last-child)), | ||
| :host([dir='rtl']:not([vertical])) ::slotted(*:not(:last-child)) { | ||
| /* .spectrum-FieldGroup--horizontal .spectrum-FieldGroup-item+.spectrum-FieldGroup-item */ | ||
| margin: 0 0 0 var(--spectrum-global-dimension-size-200); | ||
| } | ||
|
|
||
| :host([horizontal][dir='ltr']) ::slotted(*:not(:last-child)), | ||
| :host([dir='ltr']:not([vertical])) ::slotted(*:not(:last-child)) { | ||
| /* .spectrum-FieldGroup--horizontal .spectrum-FieldGroup-item+.spectrum-FieldGroup-item */ | ||
| margin: 0 var(--spectrum-global-dimension-size-200) 0 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,13 @@ | ||
| /* | ||
| 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 './FieldGroup.js'; |
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,44 @@ | ||
| /* | ||
| 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. | ||
| */ | ||
|
|
||
| const config = { | ||
| spectrum: 'fieldgroup', | ||
| components: [ | ||
| { | ||
| name: 'field-group', | ||
| host: { | ||
| selector: '.spectrum-FieldGroup', | ||
| }, | ||
| attributes: [ | ||
| { | ||
| type: 'boolean', | ||
| selector: '.spectrum-FieldGroup--horizontal', | ||
| name: 'horizontal', | ||
| }, | ||
| { | ||
| type: 'boolean', | ||
| selector: '.spectrum-FieldGroup--vertical', | ||
| name: 'vertical', | ||
| }, | ||
| ], | ||
| complexSelectors: [ | ||
| { | ||
| replacement: '::slotted(:not(:last-child))', | ||
| selector: | ||
| '.spectrum-FieldGroup-item+.spectrum-FieldGroup-item', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| export default config; |
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
Oops, something went wrong.