Skip to content

Commit

Permalink
docs(docs): docs update
Browse files Browse the repository at this point in the history 
ic-text-field docs update

BREAKING CHANGE: prop rename
  • Loading branch information
@gd2910
gd2910 committed Dec 17, 2024
1 parent 0cc2c76 commit d116d90
Show file tree
Hide file tree
Showing 23 changed files with 459 additions and 56 deletions.
283 changes: 256 additions & 27 deletions packages/docs/docs.json
View file

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-back-to-top/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@
| `variant` | `variant` | The variant of the button to render | `"default" \| "icon"` | `"default"` |


## CSS Custom Properties

| Name | Description |
| -------------------------- | ---------------------- |
| `--ic-z-index-back-to-top` | z-index of back to top |


## Dependencies

### Depends on
Expand Down
8 changes: 8 additions & 0 deletions packages/web-components/src/components/ic-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ Type: `Promise<void>`
| `"top-icon"` | Content will be placed above the button label. |


## CSS Custom Properties

| Name | Description |
| ------------- | ---------------------------- |
| `--height` | The height of the button. |
| `--min-width` | Minimum width of the button. |


## Dependencies

### Used by
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-classification-banner/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@
| `upTo` | `up-to` | If `true`, "Up to" will be displayed before the classification and country. | `boolean` | `false` |


## CSS Custom Properties

| Name | Description |
| ------------------------------------ | -------------------------------- |
| `--ic-z-index-classification-banner` | z-index of classification banner |


## Dependencies

### Depends on
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-dialog/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ Type: `Promise<void>`
| `"label"` | Content will be placed above the dialog heading. |


## CSS Custom Properties

| Name | Description |
| --------------------- | ----------------- |
| `--ic-z-index-dialog` | z-index of dialog |


## Dependencies

### Depends on
Expand Down
13 changes: 13 additions & 0 deletions packages/web-components/src/components/ic-divider/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@
| `weight` | `weight` | The thickness of the divider. | `"medium" \| "thick" \| "thin" \| "very-thick"` | `"thin"` |


## CSS Custom Properties

| Name | Description |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--ic-divider-background` | |
| `--ic-divider-background-monochrome` | |
| `--ic-divider-horizontal-width` | The width of a horizontal divider. The default value is `inherit`. |
| `--ic-divider-label` | |
| `--ic-divider-label-monochrome` | |
| `--ic-divider-label-width` | The max-width of the divider label. When orientation is set to `horizontal`, the default value is `max(20rem, 60%)`. When orientation is set to `vertical`, the default value is `20 rem`. |
| `--ic-divider-vertical-height` | The height of a vertical divider. The default value is `inherit`. |


## Dependencies

### Used by
Expand Down
19 changes: 19 additions & 0 deletions packages/web-components/src/components/ic-input-component-container/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,25 @@
| `"left-icon"` | Content will be placed to the left of the input. |


## CSS Custom Properties

| Name | Description |
| -------------------------------- | -------------------------------------------------------------------------- |
| `--border-color` | Border colour of the input component container |
| `--border-color-disabled` | Border colour of the input component container when disabled |
| `--border-color-error` | Border colour of the error variant for input component container |
| `--border-color-error-hover` | Border colour of the error hover variant for input component container |
| `--border-color-error-pressed` | Border colour of the error pressed variant for input component container |
| `--border-color-hover` | Border colour of the input component container on hover |
| `--border-color-pressed` | Border colour of the input component container when pressed |
| `--border-color-success` | Border colour of the success variant for input component container |
| `--border-color-success-hover` | Border colour of the success hover variant for input component container |
| `--border-color-success-pressed` | Border colour of the success pressed variant for input component container |
| `--border-color-warning` | Border colour of the warning variant for input component container |
| `--border-color-warning-hover` | Border colour of the warning hover variant for input component container |
| `--border-color-warning-pressed` | Border colour of the warning pressed variant for input component container |


## Dependencies

### Used by
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-loading-indicator/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@
| `"ic-loading-container"` | |


## CSS Custom Properties

| Name | Description |
| --------------------- | ---------------------------------- |
| `--circular-diameter` | Diameter of the circular-indicator |


## Dependencies

### Used by
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-menu/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ Type: `Promise<void>`



## CSS Custom Properties

| Name | Description |
| ------------------- | --------------- |
| `--ic-z-index-menu` | z-index of menu |


## Dependencies

### Used by
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-navigation-group/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ Type: `Promise<void>`



## CSS Custom Properties

| Name | Description |
| ------------------------------ | -------------------------------- |
| `--ic-z-index-navigation-item` | z-index of navigation group item |


## Dependencies

### Depends on
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-navigation-item/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ Type: `Promise<void>`
| `"link"` | The `<a>` within ic-navigation-item |


## CSS Custom Properties

| Name | Description |
| ------------------------------ | -------------------------- |
| `--ic-z-index-navigation-item` | z-index of navigation item |


## Dependencies

### Depends on
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-navigation-menu/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@
| `"navigation"` | Content will be rendered at top of panel. |


## CSS Custom Properties

| Name | Description |
| ------------------------------ | -------------------------- |
| `--ic-z-index-navigation-menu` | z-index of navigation menu |


## Dependencies

### Used by
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-page-header/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@
| `"tabs"` | Content will be rendered in the navigation area, below the title and action areas. Note: the stepper slot cannot be used when the tabs slot is being used. |


## CSS Custom Properties

| Name | Description |
| -------------------------- | ---------------------- |
| `--ic-z-index-page-header` | z-index of page-header |


## Dependencies

### Depends on
Expand Down
9 changes: 9 additions & 0 deletions packages/web-components/src/components/ic-popover-menu/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ This is a wrapper component to be placed around one or more ic-menu-item compone
| `icPopoverClosed` | Emitted when the popover menu is closed. | `CustomEvent<HTMLIcMenuItemElement>` |


## CSS Custom Properties

| Name | Description |
| ---------------------- | ----------------------------------- |
| `--ic-z-index-popover` | z-index of popover menu. |
| `--max-height` | Maximum height of the popover menu. |
| `--popover-width` | Default width of the popover menu. |


## Dependencies

### Depends on
Expand Down
9 changes: 8 additions & 1 deletion packages/web-components/src/components/ic-search-bar/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| --------------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `assistiveHintText` | `assistive-hint-text` | The hint text for the hidden assistive description element. | `string` | `"When autocomplete results are available use the up and down arrows to choose and press enter to select"` |
| `autocapitalize` | `autocapitalize` | The automatic capitalisation of the text value as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters". | `string` | `"off"` |
| `autocomplete` | `autocomplete` | The state of autocompletion the browser can apply on the text value. | `"on" \| "off" \| "name" \| "honorific-prefix" \| "given-name" \| "additional-name" \| "family-name" \| "honorific-suffix" \| "nickname" \| "email" \| "username" \| "new-password" \| "current-password" \| "one-time-code" \| "organization-title" \| "organization" \| "street-address" \| "address-line1" \| "address-line2" \| "address-line3" \| "address-level4" \| "address-level3" \| "address-level2" \| "address-level1" \| "country" \| "country-name" \| "postal-code" \| "cc-name" \| "cc-given-name" \| "cc-additional-name" \| "cc-family-name" \| "cc-number" \| "cc-exp" \| "cc-exp-month" \| "cc-exp-year" \| "cc-csc" \| "cc-type" \| "transaction-currency" \| "transaction-amount" \| "language" \| "bday" \| "bday-day" \| "bday-month" \| "bday-year" \| "sex" \| "tel" \| "tel-country-code" \| "tel-national" \| "tel-area-code" \| "tel-local" \| "tel-extension" \| "impp" \| "url" \| "photo"` | `"off"` |
| `autocomplete` | `autocomplete` | The state of autocompletion the browser can apply on the text value. | `"name" \| "on" \| "off" \| "honorific-prefix" \| "given-name" \| "additional-name" \| "family-name" \| "honorific-suffix" \| "nickname" \| "email" \| "username" \| "new-password" \| "current-password" \| "one-time-code" \| "organization-title" \| "organization" \| "street-address" \| "address-line1" \| "address-line2" \| "address-line3" \| "address-level4" \| "address-level3" \| "address-level2" \| "address-level1" \| "country" \| "country-name" \| "postal-code" \| "cc-name" \| "cc-given-name" \| "cc-additional-name" \| "cc-family-name" \| "cc-number" \| "cc-exp" \| "cc-exp-month" \| "cc-exp-year" \| "cc-csc" \| "cc-type" \| "transaction-currency" \| "transaction-amount" \| "language" \| "bday" \| "bday-day" \| "bday-month" \| "bday-year" \| "sex" \| "tel" \| "tel-country-code" \| "tel-national" \| "tel-area-code" \| "tel-local" \| "tel-extension" \| "impp" \| "url" \| "photo"` | `"off"` |
| `autocorrect` | `autocorrect` | The state of autocorrection the browser can apply when the user is entering/editing the text value. | `"off" \| "on"` | `"off"` |
| `autofocus` | `autofocus` | If `true`, the form control will have input focus when the page loads. | `boolean` | `false` |
| `charactersUntilSuggestion` | `characters-until-suggestion` | The number of characters until suggestions appear. The submit button will be disabled until the inputted value is equal to or greater than this number. | `number` | `2` |
Expand Down Expand Up @@ -70,6 +70,13 @@ Type: `Promise<void>`



## CSS Custom Properties

| Name | Description |
| ------------------- | -------------------------- |
| `--ic-z-index-menu` | z-index of search bar menu |


## Dependencies

### Depends on
Expand Down
9 changes: 9 additions & 0 deletions packages/web-components/src/components/ic-select/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ Type: `Promise<void>`
| `"icon"` | Content will be placed to the left of the select text input. |


## CSS Custom Properties

| Name | Description |
| ------------------- | -------------------------- |
| `--ic-z-index-menu` | z-index of select menu |
| `--input-width` | Width of the input field |
| `--menu-width` | Width of the dropdown menu |


## Dependencies

### Depends on
Expand Down
7 changes: 7 additions & 0 deletions packages/web-components/src/components/ic-side-navigation/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@
| `"secondary-navigation"` | Content will be rendered at the bottom of the side navigation. |


## CSS Custom Properties

| Name | Description |
| ------------------------------ | -------------------------------- |
| `--ic-z-index-side-navigation` | z-index of side navigation panel |


## Dependencies

### Depends on
Expand Down
Loading

0 comments on commit d116d90

Please sign in to comment.