@commercetools-uikit/primary-action-dropdown 12.2.4 → 12.2.9

package/README.md

@@ -1,60 +1,86 @@
+<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -->
+<!-- This file is created by the `yarn generate-readme` script. -->
+
 # PrimaryActionDropdown
 
 ## Description
 
-A `PrimaryActionDropdown` is a dropdown with any number of action whereas the
-first action of the dropdown can be triggered without opening the dropdown
+A `PrimaryActionDropdown` is a dropdown with any number of action whereas the first action of the dropdown can be triggered without opening the dropdown
 itself.
 
-The primary action, rendered as the head of the dropdown, is always the first
-non-disabled `<Option />`. If all `<Option />`s are disabled, the head of the
+The primary action, rendered as the head of the dropdown, is always the first non-disabled `<Option />`. If all `<Option />`s are disabled, the head of the
 dropdown will be disabled.
 
+## Installation
+
+```
+yarn add @commercetools-uikit/primary-action-dropdown
+```
+
+```
+npm --save install @commercetools-uikit/primary-action-dropdown
+```
+
+Additionally install the peer dependencies (if not present)
+
+```
+yarn add react
+```
+
+```
+npm --save install react
+```
+
 ## Usage
 
-```js
+```jsx
 import PrimaryActionDropdown, {
-  PrimaryActionDropdownOption,
+  Option,
 } from '@commercetools-uikit/primary-action-dropdown';
-
-<PrimaryActionDropdown>
-  <PrimaryActionDropdownOption iconLeft={<PlusBoldIcon />} onClick={() => {}}>
-    Primary option
-  </PrimaryActionDropdownOption>
-  <PrimaryActionDropdownOption onClick={() => {}}>
-    Another option
-  </PrimaryActionDropdownOption>
-  <PrimaryActionDropdownOption isDisabled={true} onClick={() => {}}>
-    Even another option
-  </PrimaryActionDropdownOption>
-</PrimaryActionDropdown>;
+import { PlusBoldIcon } from '@commercetools-uikit/icons';
+
+const Example = () => (
+  <PrimaryActionDropdown>
+    <Option iconLeft={<PlusBoldIcon />} onClick={() => {}}>
+      Primary option
+    </Option>
+    <Option onClick={() => {}}>Another option</Option>
+    <Option isDisabled={true} onClick={() => {}}>
+      Even another option
+    </Option>
+  </PrimaryActionDropdown>
+);
+
+export default Example;
 ```
 
-## Properties
+## PrimaryActionDropdown
 
-### PrimaryActionDropdown
+### Properties
 
-| Props      | Type   | Required | Values | Default | Description                                                              |
-| ---------- | ------ | :------: | ------ | ------- | ------------------------------------------------------------------------ |
-| `children` | `node` |    ✅    | -      | -       | The options of the dropdown (use the `Option` export from the component) |
+| Props      | Type                                                              | Required | Default | Description        |
+| ---------- | ----------------------------------------------------------------- | :------: | ------- | ------------------ |
+| `children` | `Array: ReactElement[]`<br/>[See signature.](#signature-children) |    ✅    |         | Any React element. |
 
-### Option
+### Signatures
 
-| Props        | Type     | Required | Values | Default | Description                                                                                        |
-| ------------ | -------- | :------: | ------ | ------- | -------------------------------------------------------------------------------------------------- |
-| `onClick`    | `func`   |    ✅    | -      | -       | What will trigger whenever the option is clicked                                                   |
-| `isDisabled` | `bool`   |    -     | -      | `false` | Disables the option within the dropdown. If all options are disabled the dropdown will be disabled |
-| `children`   | `string` |    ✅    | -      | -       | The label of the option                                                                            |
-| `iconLeft`   | `node`   |    ✅    | -      | -       | The icon left to the option (only for the primary option)                                          |
+#### Signature `children`
 
-## Invariants
+## Option
 
-1.  The `PrimaryActionDropdown` must have at least two `Option` elements as
-    `children`
+### Properties
 
-- Use a `PrimaryButton` otherwise
+| Props        | Type                                                | Required | Default | Description                                                                                         |
+| ------------ | --------------------------------------------------- | :------: | ------- | --------------------------------------------------------------------------------------------------- |
+| `onClick`    | `Function`<br/>[See signature.](#signature-onClick) |    ✅    |         | Event handler triggers whenever the option is clicked.                                              |
+| `isDisabled` | `boolean`                                           |          | `false` | Disables the option within the dropdown. If all options are disabled the dropdown will be disabled. |
+| `children`   | `string`                                            |    ✅    |         | Any string which serves as the label.                                                               |
+| `iconLeft`   | `ReactNode`                                         |    ✅    |         | Any React node.                                                                                     |
 
-Main Functions and use cases are:
+### Signatures
 
-- Export button _example: Default to export all but offer selected to be
-  exported_
+#### Signature `onClick`
+
+```ts
+() => void
+```

package/dist/commercetools-uikit-primary-action-dropdown.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index";
+export { default } from "./declarations/src/index";