@rmwc/list
Advanced tools
Comparing version 14.2.8 to 14.2.9
{ | ||
"name": "@rmwc/list", | ||
"version": "14.2.8", | ||
"version": "14.2.9", | ||
"description": "RMWC List component", | ||
@@ -48,8 +48,8 @@ "main": "./index.js", | ||
"@material/list": "^14.0.0", | ||
"@rmwc/base": "14.2.8", | ||
"@rmwc/icon": "14.2.8", | ||
"@rmwc/provider": "14.2.8", | ||
"@rmwc/ripple": "14.2.8", | ||
"@rmwc/types": "14.2.8" | ||
"@rmwc/base": "14.2.9", | ||
"@rmwc/icon": "14.2.9", | ||
"@rmwc/provider": "14.2.9", | ||
"@rmwc/ripple": "14.2.9", | ||
"@rmwc/types": "14.2.9" | ||
} | ||
} |
@@ -83,3 +83,2 @@ # Lists | ||
## List | ||
A List Component | ||
@@ -89,13 +88,12 @@ | ||
| Name | Type | Description | | ||
| ---------------- | ---------------------------------- | --------------------------------------------------------------- | | ||
| `apiRef` | `(api: null \| ListApi) => void` | An internal api used for cross component communication | | ||
| `avatarList` | `boolean` | Makes the list start detail circular for avatars. | | ||
| `children` | `ReactNode` | Children to render | | ||
| `dense` | `boolean` | Reduces the padding on List items. | | ||
| `foundationRef` | `Ref<null \| MDCListFoundation<>>` | Advanced: A reference to the MDCFoundation. | | ||
| `nonInteractive` | `boolean` | Makes the list non interactive. In addition, you'll have to set | | ||
| Name | Type | Description | | ||
|------|------|-------------| | ||
| `apiRef` | `(api: null \| ListApi) => void` | An internal api used for cross component communication | | ||
| `avatarList` | `boolean` | Makes the list start detail circular for avatars. | | ||
| `children` | `ReactNode` | Children to render | | ||
| `dense` | `boolean` | Reduces the padding on List items. | | ||
| `foundationRef` | `Ref<null \| MDCListFoundation<>>` | Advanced: A reference to the MDCFoundation. | | ||
| `nonInteractive` | `boolean` | Makes the list non interactive. In addition, you'll have to set | ||
`ripple={false}` | ||
on the individual ListItems. | | ||
on the individual ListItems. | | ||
| `onAction` | `(evt: ListOnActionEventT) => void` | A callback for when a list item is interacted with. evt.detail = number | | ||
@@ -108,4 +106,4 @@ | `selectedIndex` | `number \| number[]` | Sets the selectedIndex for singleSelection, radiogroup, or checkboxlist variants. Only supply number[] to checkboxlists | | ||
## ListItem | ||
A ListItem component. | ||
@@ -115,19 +113,21 @@ | ||
| Name | Type | Description | | ||
| ----------- | ------------- | ------------------------------------- | | ||
| `activated` | `boolean` | A modifier for an active state. | | ||
| `disabled` | `boolean` | A modifier for a disabled state. | | ||
| `ripple` | `RipplePropT` | Adds a ripple effect to the component | | ||
| `selected` | `boolean` | A modifier for a selected state. | | ||
| Name | Type | Description | | ||
|------|------|-------------| | ||
| `activated` | `boolean` | A modifier for an active state. | | ||
| `disabled` | `boolean` | A modifier for a disabled state. | | ||
| `ripple` | `RipplePropT` | Adds a ripple effect to the component | | ||
| `selected` | `boolean` | A modifier for a selected state. | | ||
## ListItemPrimaryText | ||
Primary Text for the ListItem | ||
## ListItemSecondaryText | ||
Secondary text for the ListItem | ||
## ListItemGraphic | ||
A graphic / icon for the ListItem | ||
@@ -137,32 +137,35 @@ | ||
| Name | Type | Description | | ||
| ------ | ----------- | ------------------------------------------------------------------------------------------------------ | | ||
| Name | Type | Description | | ||
|------|------|-------------| | ||
| `icon` | `IconPropT` | The icon to use. This can be a string for a font icon, a url, or whatever the selected strategy needs. | | ||
## ListItemMeta | ||
Meta content for the ListItem. This can either by an icon by setting the | ||
Meta content for the ListItem. This can either by an icon by setting the | ||
`icon` | ||
prop, or any other kind of content. | ||
prop, or any other kind of content. | ||
### Props | ||
| Name | Type | Description | | ||
| ------ | ----------- | ------------------------------------------------------------------------------------------------------ | | ||
| Name | Type | Description | | ||
|------|------|-------------| | ||
| `icon` | `IconPropT` | The icon to use. This can be a string for a font icon, a url, or whatever the selected strategy needs. | | ||
## ListDivider | ||
A divider for the List | ||
## ListGroup | ||
A container to group ListItems | ||
## ListGroupSubheader | ||
A subheader for the ListGroup | ||
## SimpleListItem | ||
A simple list item template. | ||
@@ -172,13 +175,15 @@ | ||
| Name | Type | Description | | ||
| --------------- | ------------- | ------------------------------------------------- | | ||
| `activated` | `boolean` | A modifier for an active state. | | ||
| `children` | `ReactNode` | Children to render | | ||
| `disabled` | `boolean` | A modifier for a disabled state. | | ||
| `graphic` | `IconPropT` | A graphic icon for the ListItem. | | ||
| `meta` | `ReactNode` | Meta content for the ListItem instead of an icon. | | ||
| `metaIcon` | `IconPropT` | A meta icon for the ListItem | | ||
| `ripple` | `RipplePropT` | Adds a ripple effect to the component | | ||
| `secondaryText` | `ReactNode` | Secondary Text for the ListItem. | | ||
| `selected` | `boolean` | A modifier for a selected state. | | ||
| `text` | `ReactNode` | Text for the ListItem. | | ||
| Name | Type | Description | | ||
|------|------|-------------| | ||
| `activated` | `boolean` | A modifier for an active state. | | ||
| `children` | `ReactNode` | Children to render | | ||
| `disabled` | `boolean` | A modifier for a disabled state. | | ||
| `graphic` | `IconPropT` | A graphic icon for the ListItem. | | ||
| `meta` | `ReactNode` | Meta content for the ListItem instead of an icon. | | ||
| `metaIcon` | `IconPropT` | A meta icon for the ListItem | | ||
| `ripple` | `RipplePropT` | Adds a ripple effect to the component | | ||
| `secondaryText` | `ReactNode` | Secondary Text for the ListItem. | | ||
| `selected` | `boolean` | A modifier for a selected state. | | ||
| `text` | `ReactNode` | Text for the ListItem. | | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
46122
788
184
14
1
1
+ Added@rmwc/base@14.2.9(transitive)
+ Added@rmwc/icon@14.2.9(transitive)
+ Added@rmwc/provider@14.2.9(transitive)
+ Added@rmwc/ripple@14.2.9(transitive)
+ Added@rmwc/types@14.2.9(transitive)
- Removed@rmwc/base@14.2.8(transitive)
- Removed@rmwc/icon@14.2.8(transitive)
- Removed@rmwc/provider@14.2.8(transitive)
- Removed@rmwc/ripple@14.2.8(transitive)
- Removed@rmwc/types@14.2.8(transitive)
Updated@rmwc/base@14.2.9
Updated@rmwc/icon@14.2.9
Updated@rmwc/provider@14.2.9
Updated@rmwc/ripple@14.2.9
Updated@rmwc/types@14.2.9