@smui/common
Advanced tools
Comparing version 3.0.0-beta.1 to 3.0.0-beta.2
@@ -6,2 +6,10 @@ # Change Log | ||
# [3.0.0-beta.2](https://github.com/hperrin/svelte-material-ui/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2021-04-11) | ||
**Note:** Version bump only for package @smui/common | ||
# [3.0.0-beta.1](https://github.com/hperrin/svelte-material-ui/compare/v3.0.0-beta.0...v3.0.0-beta.1) (2021-04-11) | ||
@@ -8,0 +16,0 @@ |
{ | ||
"name": "@smui/common", | ||
"version": "3.0.0-beta.1", | ||
"version": "3.0.0-beta.2", | ||
"description": "Svelte Material UI - Common", | ||
@@ -32,3 +32,3 @@ "keywords": [ | ||
}, | ||
"gitHead": "cb540acac526bf8f131fa9615176ee586bb7de80" | ||
"gitHead": "58f516218cbdc1f52c2b4d9cda801008085371f4" | ||
} |
@@ -13,6 +13,2 @@ # Svelte Material UI - Common Components | ||
# Whoa There, These Docs are Outdated | ||
The latest SMUI v3 beta had a lot of changes, and these docs haven't been caught up yet. You should check out the demo page's code to see the latest usage. | ||
# Exports | ||
@@ -24,7 +20,7 @@ | ||
The common label is used everywhere except for the `list` components. | ||
The common label is used everywhere that exports a `Label` component. | ||
### Props / Defaults | ||
- `use`: `[]` - An array of actions and/or action/property arrays. | ||
- `use`: `[]` - An array of Svelte actions and/or arrays of an action and its options. | ||
- `class`: `''` - A CSS class string. | ||
@@ -40,12 +36,10 @@ | ||
The common icon is used everywhere except for the `textfield` and `select` components. | ||
The common icon is used everywhere that exports an `Icon` component except for `textfield` and `select`. | ||
### Props / Defaults | ||
- `use`: `[]` - An array of actions and/or action/property arrays. | ||
- `component`: `I` - A component to use as the root element. | ||
- `use`: `[]` - An array of Svelte actions and/or arrays of an action and its options. | ||
- `class`: `''` - A CSS class string. | ||
- `on`: `false` - Used in the context of an icon button toggle to denote the icon for when the button is on. | ||
- `leading`: `false` - Used in the context of a chip to denote that the icon is a leading icon. | ||
- `leadingHidden`: `false` - Used in the context of a filter chip to hide the icon when the chip is selected. | ||
- `trailing`: `false` - Used in the context of a chip to denote that the icon is a trailing icon. | ||
@@ -66,7 +60,25 @@ ### Events | ||
- `use`: `[]` - An array of actions and/or action/property arrays. | ||
- `component`: `(depends on context)` - The component to extend. Usually it is set to one of the elemental components below. | ||
- `use`: `[]` - An array of Svelte actions and/or arrays of an action and its options. | ||
- `class`: `''` - A CSS class string. | ||
- `component`: `(depends on context)` - The component to extend. Usually it is set to one of the elemental components below. | ||
- `forwardEvents`: `[]` - An array of additional events that should be forwarded. | ||
## ContextFragment.svelte | ||
A fragment component (only contains a `<slot />`) used to define a Svelte context with a Svelte store. | ||
### Props / Defaults | ||
- `key`: `undefined` - The key of the Svelte context. | ||
- `value`: `undefined` - The value of the store contained in the Svelte context. The store will be updated when the value changes. | ||
# Elemental Components | ||
These components are used in SMUI components that take a `component` prop. They determine which HTML element will be used as the root element of the component. | ||
### Props / Defaults (Common to all Elemental Components) | ||
- `use`: `[]` - An array of Svelte actions and/or arrays of an action and its options. | ||
- `forwardEvents`: `[]` - An array of additional events that should be forwarded. | ||
## A.svelte | ||
@@ -120,2 +132,10 @@ | ||
## Hr.svelte | ||
An elemental component for the `hr` tag. | ||
## I.svelte | ||
An elemental component for the `i` tag. | ||
## Img.svelte | ||
@@ -129,2 +149,10 @@ | ||
## Main.svelte | ||
An elemental component for the `main` tag. | ||
## Nav.svelte | ||
An elemental component for the `nav` tag. | ||
## Section.svelte | ||
@@ -138,4 +166,8 @@ | ||
## Svg.svelte | ||
An elemental component for the `svg` tag. | ||
## Ul.svelte | ||
An elemental component for the `ul` tag. |
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
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
43223
167