-
Notifications
You must be signed in to change notification settings - Fork 6
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
1 changed file
with
129 additions
and
49 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,154 @@ | ||
| This component is an extension of [<mwc-check-list-item>](https://github.com/material-components/material-components-web-components/tree/master/packages/list) | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Modifiers | Type | | ||
| | ------------------ | --------- | ------------------------- | | ||
| | `activated` | | `boolean` | | ||
| | `disabled` | | `boolean` | | ||
| | `graphic` | | `GraphicType` | | ||
| | `group` | | `string \| null` | | ||
| | `hasMeta` | | `boolean` | | ||
| | `left` | | `boolean` | | ||
| | `multipleGraphics` | | `boolean` | | ||
| | `noninteractive` | | `boolean` | | ||
| | `ripple` | | `Promise<Ripple \| null>` | | ||
| | `selected` | | `boolean` | | ||
| | `tabindex` | | `number` | | ||
| | `text` | readonly | `string` | | ||
| | `twoline` | | `boolean` | | ||
| | `value` | | `string` | | ||
|
|
||
| ## Events | ||
|
|
||
| | Event | Type | | ||
| | -------------------- | ----------------------- | | ||
| | `list-item-rendered` | | | ||
| | `request-selected` | `RequestSelectedDetail` | | ||
|
|
||
| # vwc-list-expansion-panel | ||
|
|
||
| This component support expand-collapse list | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Type | | ||
| | -------------------- | ------------------------------------ | | ||
| | `headerListItemIcon` | `VWCIcon \| undefined` | | ||
| | `headerNodes` | `HTMLElement[] \| null \| undefined` | | ||
| | `open` | `boolean` | | ||
|
|
||
| ## Methods | ||
|
|
||
| | Method | Type | Description | | ||
| | ------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `close` | `(): void` | | | ||
| | `notifyClose` | `(): void` | | | ||
| | `notifyOpen` | `(): void` | | | ||
| | `openChanged` | `(isOpen: boolean): void` | Invoked when the element open state is updated.<br /><br />Expressions inside this method will trigger upon open state change<br /><br />**\_isOpen**: Boolean of open state | | ||
| | `show` | `(): void` | | | ||
|
|
||
| # vwc-list-item | ||
|
|
||
| This component is an extension of [<mwc-list-item>](https://github.com/material-components/material-components-web-components/tree/master/packages/list) | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Modifiers | Type | | ||
| |---------------------------|-----------|-------------------------------------------| | ||
| | `activated` | | `boolean` | | ||
| | `disabled` | | `boolean` | | ||
| | `floatingLabelFoundation` | | `MDCFloatingLabelFoundation \| undefined` | | ||
| | `graphic` | | `GraphicType` | | ||
| | `group` | | `string \| null` | | ||
| | `hasMeta` | | `boolean` | | ||
| | `lineRippleFoundation` | | `MDCLineRippleFoundation \| undefined` | | ||
| | `multipleGraphics` | | `boolean` | | ||
| | `noninteractive` | | `boolean` | | ||
| | `ripple` | | `Promise<Ripple \| null>` | | ||
| | `selected` | | `boolean` | | ||
| | `tabindex` | | `number` | | ||
| | `text` | readonly | `string` | | ||
| | `twoline` | | `boolean` | | ||
| | `value` | | `string` | | ||
| | Property | Modifiers | Type | | ||
| | ------------------ | --------- | ------------------------- | | ||
| | `activated` | | `boolean` | | ||
| | `disabled` | | `boolean` | | ||
| | `graphic` | | `GraphicType` | | ||
| | `group` | | `string \| null` | | ||
| | `hasMeta` | | `boolean` | | ||
| | `multipleGraphics` | | `boolean` | | ||
| | `noninteractive` | | `boolean` | | ||
| | `ripple` | | `Promise<Ripple \| null>` | | ||
| | `selected` | | `boolean` | | ||
| | `tabindex` | | `number` | | ||
| | `text` | readonly | `string` | | ||
| | `twoline` | | `boolean` | | ||
| | `value` | | `string` | | ||
|
|
||
| ## Events | ||
|
|
||
| | Event | Description | | ||
| |----------------------|-------------------------| | ||
| | Event | Type | | ||
| | -------------------- | ----------------------- | | ||
| | `list-item-rendered` | | | ||
| | `request-selected` | {RequestSelectedDetail} | | ||
|
|
||
| | `request-selected` | `RequestSelectedDetail` | | ||
|
|
||
| # vwc-list | ||
|
|
||
| This component is an extension of [<mwc-list>](https://github.com/material-components/material-components-web-components/tree/master/packages/list) | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Modifiers | Type | | ||
| |---------------------------|-----------|------------------------------------------------| | ||
| | `activatable` | | `boolean` | | ||
| | `floatingLabelFoundation` | | `MDCFloatingLabelFoundation \| undefined` | | ||
| | `index` | readonly | `MWCListIndex` | | ||
| | `innerAriaLabel` | | `string \| null` | | ||
| | `innerRole` | | `string \| null` | | ||
| | `itemRoles` | | `string \| null` | | ||
| | `items` | readonly | `ListItemBase[]` | | ||
| | `layout` | | `(updateItems?: boolean \| undefined) => void` | | ||
| | `lineRippleFoundation` | | `MDCLineRippleFoundation \| undefined` | | ||
| | `multi` | | `boolean` | | ||
| | `noninteractive` | | `boolean` | | ||
| | `rootTabbable` | | `boolean` | | ||
| | `selected` | readonly | `ListItemBase \| ListItemBase[] \| null` | | ||
| | `wrapFocus` | | `boolean` | | ||
| | Property | Modifiers | Type | | ||
| | ----------------- | --------- | ----------------------------------------------------------- | | ||
| | `activatable` | | `boolean` | | ||
| | `debouncedLayout` | | `(updateItems?: boolean \| undefined) => void \| undefined` | | ||
| | `emptyMessage` | | `string \| undefined` | | ||
| | `index` | readonly | `MWCListIndex` | | ||
| | `innerAriaLabel` | | `string \| null` | | ||
| | `innerRole` | | `string \| null` | | ||
| | `itemRoles` | | `string \| null` | | ||
| | `items` | readonly | `ListItemBase[]` | | ||
| | `itemsReady` | | `Promise<never[]>` | | ||
| | `layout` | | `object` | | ||
| | `multi` | | `boolean` | | ||
| | `noninteractive` | | `boolean` | | ||
| | `rootTabbable` | | `boolean` | | ||
| | `selected` | readonly | `ListItemBase \| ListItemBase[] \| null` | | ||
| | `wrapFocus` | | `boolean` | | ||
|
|
||
| ## Methods | ||
|
|
||
| | Method | Type | | ||
| |-----------------------|--------------------------------------------------| | ||
| | `blur` | `(): void` | | ||
| | `focus` | `(): void` | | ||
| | `focusItemAtIndex` | `(index: number): void` | | ||
| | `getFocusedItemIndex` | `(): number` | | ||
| | `layout` | `(updateItems?: boolean \| undefined): void` | | ||
| | `select` | `(index: MWCListIndex): void` | | ||
| | Method | Type | | ||
| | --------------------- | ----------------------------------------------------- | | ||
| | `blur` | `(): void` | | ||
| | `click` | `(): void` | | ||
| | `focus` | `(): void` | | ||
| | `focusItemAtIndex` | `(index: number): void` | | ||
| | `getFocusedItemIndex` | `(): number` | | ||
| | `layout` | `(updateItems?: boolean \| undefined): void` | | ||
| | `renderPlaceholder` | `(): TemplateResult \| null` | | ||
| | `select` | `(index: MWCListIndex): void` | | ||
| | `toggle` | `(index: number, force?: boolean \| undefined): void` | | ||
|
|
||
| ## Events | ||
|
|
||
| | Event | Description | | ||
| |-----------------|------------------| | ||
| | `action` | {ActionDetail} | | ||
| | Event | Type | | ||
| | --------------- | ---------------- | | ||
| | `action` | `ActionDetail` | | ||
| | `items-updated` | | | ||
| | `selected` | {SelectedDetail} | | ||
| | `selected` | `SelectedDetail` | | ||
|
|
||
| # vwc-radio-list-item | ||
|
|
||
| This component is an extension of [<mwc-radio-list-item>](https://github.com/material-components/material-components-web-components/tree/master/packages/list) | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Modifiers | Type | | ||
| | ------------------ | --------- | ------------------------- | | ||
| | `activated` | | `boolean` | | ||
| | `disabled` | | `boolean` | | ||
| | `graphic` | | `GraphicType` | | ||
| | `group` | | `string \| null` | | ||
| | `hasMeta` | | `boolean` | | ||
| | `left` | | `boolean` | | ||
| | `multipleGraphics` | | `boolean` | | ||
| | `noninteractive` | | `boolean` | | ||
| | `ripple` | | `Promise<Ripple \| null>` | | ||
| | `selected` | | `boolean` | | ||
| | `tabindex` | | `number` | | ||
| | `text` | readonly | `string` | | ||
| | `twoline` | | `boolean` | | ||
| | `value` | | `string` | | ||
|
|
||
| ## Events | ||
|
|
||
| | Event | Type | | ||
| | -------------------- | ----------------------- | | ||
| | `list-item-rendered` | | | ||
| | `request-selected` | `RequestSelectedDetail` | |