From 36294e6d359fe783573ddbd753379936e4acb2ad Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Fri, 22 May 2020 16:30:06 -0400 Subject: [PATCH] Remove docs-readme output target --- src/components/alert/readme.md | 47 +-------- src/components/button/readme.md | 123 +--------------------- src/components/checkbox/readme.md | 11 +- src/components/color-picker/readme.md | 10 +- src/components/dialog/readme.md | 22 +--- src/components/dropdown-divider/readme.md | 5 +- src/components/dropdown-item/readme.md | 5 +- src/components/dropdown/readme.md | 62 +---------- src/components/icon/readme.md | 40 +------ src/components/input/readme.md | 76 +------------ src/components/progress-bar/readme.md | 19 +--- src/components/progress-ring/readme.md | 14 +-- src/components/radio/readme.md | 10 +- src/components/range/readme.md | 31 +----- src/components/spinner/readme.md | 10 +- src/components/switch/readme.md | 9 +- src/components/tab-group/readme.md | 123 +--------------------- src/components/tab-panel/readme.md | 5 +- src/components/tab/readme.md | 5 +- src/components/textarea/readme.md | 13 +-- src/components/tooltip/readme.md | 28 +---- stencil.config.ts | 4 - 22 files changed, 46 insertions(+), 626 deletions(-) diff --git a/src/components/alert/readme.md b/src/components/alert/readme.md index 3c03043d1..bd49ec2a3 100644 --- a/src/components/alert/readme.md +++ b/src/components/alert/readme.md @@ -1,49 +1,6 @@ -# Alert +# sl-alert -```html preview - - Nothing fancy here, just a simple alert. -
- - - This one is a bit fancier because now it has an icon and is closable. - -``` - -## Types - -```html preview - - - Your changes have been saved
- You can continue working or safely leave the app now. -

- - - - Your changes have been saved
- You can continue working or safely leave the app now. -

- - - - Your changes have been saved
- You can continue working or safely leave the app now. -

- - - - Your changes have been saved
- You can continue working or safely leave the app now. -

- - - - Your changes have been saved
- You can continue working or safely leave the app now. -
-``` @@ -114,4 +71,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/button/readme.md b/src/components/button/readme.md index c4fc2b5b8..652b0fa5d 100644 --- a/src/components/button/readme.md +++ b/src/components/button/readme.md @@ -1,124 +1,5 @@ -# Button +# sl-button -Good ol' buttons. They're usually the first thing I look at when reviewing a component library. Shoelace offers a variation for every theme color. - -```html preview -Default -Primary -Success -Info -Warning -Danger -``` - -## Pill - -Use the `pill` prop to give buttons rounded edges. - -```html preview -Default -Primary -Success -Info -Warning -Danger -``` - -## Sizes - -Use the `size` prop to change a button's size. - -```html preview -Small -Medium -Large -``` - -## Circle - -Use the `circle` prop to create circular icon buttons. - -```html preview - - - -``` - -## Text - -Use `type="text"` to create text buttons, which share the same size as regular buttons but don't have backgrounds or borders. - -```html preview -Text -Text -Text -``` - -## Block - -Block buttons can be created by setting the button's width to `100%`. - -```html preview -Small -Medium -Large -``` - -## Icons - -Use the `prefix` and `suffix` slots to add icons. - -```html preview - - - Settings - - - - Refresh - - - - - Open - -``` - -## Caret - -Use the `caret` prop to add a dropdown indicator when a button will trigger a dropdown, menu, or popover. - -```html preview -Small -Medium -Large -``` - -## Loading - -Use the `loading` prop to make a button busy. The width will remain the same as before, preventing adjacent elements from moving around. - -```html preview -Default -Primary -Success -Info -Warning -Danger -``` - -## Disabled - -Use the `disabled` prop to disable a button. - -```html preview -Default -Primary -Success -Info -Warning -Danger -``` @@ -197,4 +78,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/checkbox/readme.md b/src/components/checkbox/readme.md index 48e06a276..4c57bfef9 100644 --- a/src/components/checkbox/readme.md +++ b/src/components/checkbox/readme.md @@ -1,11 +1,6 @@ -# Checkbox +# sl-checkbox + -```html preview -Default

-Checked

-Indeterminate

-Disabled

-``` @@ -62,4 +57,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/color-picker/readme.md b/src/components/color-picker/readme.md index 40ff38cda..f98563b71 100644 --- a/src/components/color-picker/readme.md +++ b/src/components/color-picker/readme.md @@ -1,12 +1,6 @@ -# Color Picker +# sl-color-picker -```html preview - -``` -```html preview - -``` @@ -59,4 +53,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/dialog/readme.md b/src/components/dialog/readme.md index a1793c3b5..ca43d0c78 100644 --- a/src/components/dialog/readme.md +++ b/src/components/dialog/readme.md @@ -1,24 +1,6 @@ -# Dialog +# sl-dialog -```html preview - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. - Close - -Open Dialog - - -``` @@ -97,4 +79,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/dropdown-divider/readme.md b/src/components/dropdown-divider/readme.md index 139a7d3d6..8186cee4f 100644 --- a/src/components/dropdown-divider/readme.md +++ b/src/components/dropdown-divider/readme.md @@ -1,6 +1,5 @@ -# Dropdown Divider +# sl-dropdown-divider -TODO @@ -8,4 +7,4 @@ TODO ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/dropdown-item/readme.md b/src/components/dropdown-item/readme.md index ddd8e3eeb..b0b647aba 100644 --- a/src/components/dropdown-item/readme.md +++ b/src/components/dropdown-item/readme.md @@ -1,6 +1,5 @@ -# Dropdown Item +# sl-dropdown-item -TODO @@ -47,4 +46,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/dropdown/readme.md b/src/components/dropdown/readme.md index 1a118016f..de1757b93 100644 --- a/src/components/dropdown/readme.md +++ b/src/components/dropdown/readme.md @@ -1,63 +1,5 @@ -# Dropdown +# sl-dropdown -```html preview - - Dropdown - Dropdown Item 1 - Dropdown Item 2 - Dropdown Item 3 - - Checked - Disabled - - - Prefix - - - - Suffix Icon - - - -``` - -```html preview - - Edit - Cut - Copy - Paste - - Find - Replace - -``` - -```html preview - - Scrolling Menu - Item 1 - Item 2 - Item 3 - Item 4 - Item 5 - Item 6 - Item 7 - Item 8 - Item 9 - Item 10 - Item 11 - Item 12 - Item 13 - Item 14 - Item 15 - Item 16 - Item 17 - Item 18 - Item 19 - Item 20 - -``` @@ -128,4 +70,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/icon/readme.md b/src/components/icon/readme.md index 0fca550f8..2962bc2bf 100644 --- a/src/components/icon/readme.md +++ b/src/components/icon/readme.md @@ -1,42 +1,6 @@ -# Icon +# sl-icon -```html preview -
- - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - -
-``` - -Icons are courtesy of [Feather Icons](https://feathericons.com/). @@ -76,4 +40,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/input/readme.md b/src/components/input/readme.md index c68009cda..26f1754b1 100644 --- a/src/components/input/readme.md +++ b/src/components/input/readme.md @@ -1,77 +1,5 @@ -# Input +# sl-input -```html preview - - -

- - - -

- - - -

- - - - - - -

- - - - - - -

- - - - - - -

- - - -

- - - -

- - - -

- - - -

- - - -

- - - -

- - - -

- - - -

- - - -

- - -``` @@ -198,4 +126,4 @@ graph TD; ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/progress-bar/readme.md b/src/components/progress-bar/readme.md index 41f4eebe9..c005c1f71 100644 --- a/src/components/progress-bar/readme.md +++ b/src/components/progress-bar/readme.md @@ -1,20 +1,5 @@ -# Progress Bar +# sl-progress-bar -```html preview -
-
-
-
- -``` - -```html preview -0%
-25%
-50%
-75%
-100% -``` @@ -37,4 +22,4 @@ ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/progress-ring/readme.md b/src/components/progress-ring/readme.md index 9f6c23472..242f466e0 100644 --- a/src/components/progress-ring/readme.md +++ b/src/components/progress-ring/readme.md @@ -1,14 +1,6 @@ -# Progress Ring +# sl-progress-ring + -```html preview -
- 0%
- 25%
- 50%
- 75%
- 100% -
-``` @@ -24,4 +16,4 @@ ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/radio/readme.md b/src/components/radio/readme.md index ba8dbd1fe..c0c74f9fc 100644 --- a/src/components/radio/readme.md +++ b/src/components/radio/readme.md @@ -1,10 +1,6 @@ -# Radio +# sl-radio + -```html preview -Default

-Checked

-Disabled

-``` @@ -60,4 +56,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/range/readme.md b/src/components/range/readme.md index 138f95549..53b1aba69 100644 --- a/src/components/range/readme.md +++ b/src/components/range/readme.md @@ -1,33 +1,6 @@ -# Range +# sl-range -```html preview - -

- - - -

- - - - -

- - - -

- - - -

- - -``` @@ -80,4 +53,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/spinner/readme.md b/src/components/spinner/readme.md index cbe5d5bbf..549b7d6cd 100644 --- a/src/components/spinner/readme.md +++ b/src/components/spinner/readme.md @@ -1,10 +1,6 @@ -# Spinner +# sl-spinner + -```html preview - - - -``` @@ -19,4 +15,4 @@ ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/switch/readme.md b/src/components/switch/readme.md index ee5420522..51c5b3b9d 100644 --- a/src/components/switch/readme.md +++ b/src/components/switch/readme.md @@ -1,10 +1,5 @@ -# Switch +# sl-switch -```html preview -Switch

-Checked

-Disabled

-``` @@ -61,4 +56,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/tab-group/readme.md b/src/components/tab-group/readme.md index 1bdc526ec..0f6c94593 100644 --- a/src/components/tab-group/readme.md +++ b/src/components/tab-group/readme.md @@ -1,124 +1,5 @@ -# Tab Group +# sl-tab-group -```html preview - - General - Custom - Advanced - Disabled - - General - Custom - Advanced - Disabled - -``` - -```html preview - - General - Custom - Advanced - Disabled - - General - Custom - Advanced - Disabled - -``` - -```html preview - - General - Custom - Advanced - Disabled - - General - Custom - Advanced - Disabled - -``` - -```html preview - - General - Custom - Advanced - Disabled - - General - Custom - Advanced - Disabled - -``` - -```html preview - - Tab 1 - Tab 2 - Tab 3 - Tab 4 - Tab 5 - Tab 6 - Tab 7 - Tab 8 - Tab 9 - Tab 10 - Tab 11 - Tab 12 - Tab 13 - Tab 14 - Tab 15 - Tab 16 - Tab 17 - Tab 18 - Tab 19 - Tab 20 - - Tab panel 1 - Tab panel 2 - Tab panel 3 - Tab panel 4 - Tab panel 5 - Tab panel 6 - Tab panel 7 - Tab panel 8 - Tab panel 9 - Tab panel 10 - Tab panel 11 - Tab panel 12 - Tab panel 13 - Tab panel 14 - Tab panel 15 - Tab panel 16 - Tab panel 17 - Tab panel 18 - Tab panel 19 - Tab panel 20 - -``` - -## Notes - -Serious consideration was given to simplifying the tab group API into two components with a structure similar to: - -```html - - - General - Custom - Advanced - Disabled - -``` - -However, there are two caveats to this approach. The first is that labels must be generated and stored in the tab group's shadow DOM. For accessibility reasons, tabs and tab panels must be linked via `id` using the `aria-controls` and `aria-labeledby` attribute, respectively. When a tab is inside a shadow DOM, its `id` becomes inaccessible to the light DOM and accessibility is broken. - -The second thing is that labels would be limited to text only. If you wanted to put an icon, a badge, or another element inside the label, it wouldn't be possible with this approach. @@ -162,4 +43,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/tab-panel/readme.md b/src/components/tab-panel/readme.md index d386f40b2..cf612963c 100644 --- a/src/components/tab-panel/readme.md +++ b/src/components/tab-panel/readme.md @@ -1,6 +1,5 @@ -# Tab Panel +# sl-tab-panel -TODO @@ -23,4 +22,4 @@ TODO ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/tab/readme.md b/src/components/tab/readme.md index 75e7d20c4..84bb02314 100644 --- a/src/components/tab/readme.md +++ b/src/components/tab/readme.md @@ -1,6 +1,5 @@ -# Tab +# sl-tab -TODO @@ -47,4 +46,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/textarea/readme.md b/src/components/textarea/readme.md index a19eb1277..d28d20b2e 100644 --- a/src/components/textarea/readme.md +++ b/src/components/textarea/readme.md @@ -1,14 +1,5 @@ -# Textarea +# sl-textarea -```html preview -

- -

- -

- -

-``` @@ -100,4 +91,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/src/components/tooltip/readme.md b/src/components/tooltip/readme.md index d14c37a81..5d4beb68b 100644 --- a/src/components/tooltip/readme.md +++ b/src/components/tooltip/readme.md @@ -1,29 +1,5 @@ -# Tooltip +# sl-tooltip -```html preview -Tooltip -This is a tooltip - -Tooltip With Arrow -This is a tooltip with arrow - -Tooltip On Link -This is a tooltip on a link - -

- -Top -Tooltip - -Bottom -Tooltip - -Left -Tooltip - -Right -Tooltip -``` @@ -88,4 +64,4 @@ Type: `Promise` ---------------------------------------------- - +*Built with [StencilJS](https://stenciljs.com/)* diff --git a/stencil.config.ts b/stencil.config.ts index ee65312d7..2304a00ae 100644 --- a/stencil.config.ts +++ b/stencil.config.ts @@ -20,10 +20,6 @@ export const config: Config = { { type: 'dist-custom-elements-bundle' }, - { - type: 'docs-readme', - footer: '' - }, { type: 'docs-json', file: './dist/components.json'