@commercetools-uikit/icon-button 12.2.2 → 12.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -2
- package/dist/commercetools-uikit-icon-button.cjs.dev.js +49 -47
- package/dist/commercetools-uikit-icon-button.cjs.prod.js +37 -36
- package/dist/commercetools-uikit-icon-button.esm.js +35 -32
- package/dist/declarations/src/icon-button.d.ts +20 -20
- package/dist/declarations/src/icon-button.styles.d.ts +8 -8
- package/dist/declarations/src/index.d.ts +2 -2
- package/dist/declarations/src/version.d.ts +2 -2
- package/package.json +9 -13
package/README.md
CHANGED
|
@@ -30,7 +30,6 @@ npm --save install react
|
|
|
30
30
|
## Usage
|
|
31
31
|
|
|
32
32
|
```jsx
|
|
33
|
-
import React from 'react';
|
|
34
33
|
import IconButton from '@commercetools-uikit/icon-button';
|
|
35
34
|
import { InformationIcon } from '@commercetools-uikit/icons';
|
|
36
35
|
|
|
@@ -52,7 +51,7 @@ export default Example;
|
|
|
52
51
|
| `as` | `TStringOrComponent` | | | You may pass in a string like "a" to have the button element render an anchor tag, or
you could pass in a React Component, like a `Link`.
<br />
The `<IconButton>` additionally accepts any props or attributes specific to the given element or component. |
|
|
53
52
|
| `type` | `union`<br/>Possible values:<br/>`'button' , 'reset' , 'submit'` | | `'button'` | Used as the HTML type attribute. |
|
|
54
53
|
| `label` | `string` | ✅ | | Should describe what the button does, for accessibility purposes (screen-reader users) |
|
|
55
|
-
| `icon` | `
|
|
54
|
+
| `icon` | `ReactElement` | | | an <Icon /> component |
|
|
56
55
|
| `isToggleButton` | `boolean` | | `false` | If this is active, it means the button will persist in an "active" state when toggled (see `isToggled`), and back to normal state when untoggled. |
|
|
57
56
|
| `isToggled` | `boolean` | | | Tells when the button should present a toggled state. It does not have any effect when `isToggleButton` is `false`. |
|
|
58
57
|
| `isDisabled` | `boolean` | | | Tells when the button should present a disabled state. |
|