From 90639f6c833836a2ec197bd9824694b979ed4df2 Mon Sep 17 00:00:00 2001 From: Ben Elan Date: Wed, 1 Dec 2021 10:12:31 -0800 Subject: [PATCH] docs: update component READMEs (#3606) Co-authored-by: jcfranco --- src/components/calcite-split-button/readme.md | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/src/components/calcite-split-button/readme.md b/src/components/calcite-split-button/readme.md index ec8769ac22e..848998c8e6c 100644 --- a/src/components/calcite-split-button/readme.md +++ b/src/components/calcite-split-button/readme.md @@ -20,21 +20,22 @@ The calcite-split-button control is one that combines a button with a dropdown m ## Properties -| Property | Attribute | Description | Type | Default | -| -------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ----------- | -| `appearance` | `appearance` | specify the appearance style of the button, defaults to solid. | `"clear" \| "outline" \| "solid" \| "transparent"` | `"solid"` | -| `color` | `color` | specify the color of the control, defaults to blue | `"blue" \| "inverse" \| "neutral" \| "red"` | `"blue"` | -| `disabled` | `disabled` | is the control disabled | `boolean` | `false` | -| `dropdownIconType` | `dropdown-icon-type` | specify the icon used for the dropdown menu, defaults to chevron | `"caret" \| "chevron" \| "ellipsis" \| "overflow"` | `"chevron"` | -| `dropdownLabel` | `dropdown-label` | aria label for overflow button | `string` | `undefined` | -| `loading` | `loading` | optionally add a calcite-loader component to the control, disabling interaction. with the primary button | `boolean` | `false` | -| `primaryIconEnd` | `primary-icon-end` | optionally pass an icon to display at the end of the primary button - accepts Calcite UI icon names | `string` | `undefined` | -| `primaryIconFlipRtl` | `primary-icon-flip-rtl` | flip the primary icon(s) in rtl | `"both" \| "end" \| "start"` | `undefined` | -| `primaryIconStart` | `primary-icon-start` | optionally pass an icon to display at the start of the primary button - accepts Calcite UI icon names | `string` | `undefined` | -| `primaryLabel` | `primary-label` | optionally pass an aria-label for the primary button | `string` | `undefined` | -| `primaryText` | `primary-text` | text for primary action button | `string` | `undefined` | -| `scale` | `scale` | specify the scale of the control, defaults to m | `"l" \| "m" \| "s"` | `"m"` | -| `width` | `width` | specify the width of the button, defaults to auto | `"auto" \| "full" \| "half"` | `"auto"` | +| Property | Attribute | Description | Type | Default | +| -------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------------ | +| `appearance` | `appearance` | specify the appearance style of the button, defaults to solid. | `"clear" \| "outline" \| "solid" \| "transparent"` | `"solid"` | +| `color` | `color` | specify the color of the control, defaults to blue | `"blue" \| "inverse" \| "neutral" \| "red"` | `"blue"` | +| `disabled` | `disabled` | is the control disabled | `boolean` | `false` | +| `dropdownIconType` | `dropdown-icon-type` | specify the icon used for the dropdown menu, defaults to chevron | `"caret" \| "chevron" \| "ellipsis" \| "overflow"` | `"chevron"` | +| `dropdownLabel` | `dropdown-label` | aria label for overflow button | `string` | `undefined` | +| `loading` | `loading` | optionally add a calcite-loader component to the control, disabling interaction. with the primary button | `boolean` | `false` | +| `overlayPositioning` | `overlay-positioning` | Describes the type of positioning to use for the dropdown. If your element is in a fixed container, use the 'fixed' value. | `"absolute" \| "fixed"` | `"absolute"` | +| `primaryIconEnd` | `primary-icon-end` | optionally pass an icon to display at the end of the primary button - accepts Calcite UI icon names | `string` | `undefined` | +| `primaryIconFlipRtl` | `primary-icon-flip-rtl` | flip the primary icon(s) in rtl | `"both" \| "end" \| "start"` | `undefined` | +| `primaryIconStart` | `primary-icon-start` | optionally pass an icon to display at the start of the primary button - accepts Calcite UI icon names | `string` | `undefined` | +| `primaryLabel` | `primary-label` | optionally pass an aria-label for the primary button | `string` | `undefined` | +| `primaryText` | `primary-text` | text for primary action button | `string` | `undefined` | +| `scale` | `scale` | specify the scale of the control, defaults to m | `"l" \| "m" \| "s"` | `"m"` | +| `width` | `width` | specify the width of the button, defaults to auto | `"auto" \| "full" \| "half"` | `"auto"` | ## Events