@paprika/radio - npm Package Compare versions

Comparing version 0.1.18 to 0.1.19

lib/Radio.js

@@ -55,9 +55,9 @@ "use strict";
 
-  /* Name provided for accessibility */
+  /** Name provided for accessibility */
   name: _propTypes["default"].string,
 
-  /* onClick provided by parent Group component */
+  /** onClick provided by parent Group component */
   onClick: function onClick() {},
 
-  /* Size provided by parent Group component */
+  /** Size provided by parent Group component */
   size: _propTypes["default"].oneOf(_customPropTypes.ShirtSizes.DEFAULT),
@@ -64,0 +64,0 @@

package.json

 {
   "name": "@paprika/radio",
-  "version": "0.1.18",
-  "description": "Radio component",
+  "version": "0.1.19",
+  "description": "Radio component displays a radio input and label text beside it. When clicked it selects the input and deselects any other radio input in its group",
   "author": "@paprika",
@@ -19,3 +19,3 @@ "license": "MIT",
     "@paprika/helpers": "^0.2.11",
-    "@paprika/icon": "^0.3.1",
+    "@paprika/icon": "^0.3.2",
     "@paprika/stylers": "^0.2.7",
@@ -31,3 +31,8 @@ "@paprika/tokens": "^0.1.14",
   },
-  "gitHead": "148dd63200bbd736eba9e024527a48d8e6beb4e6"
+  "paprikaDocs": {
+    "subComponents": [
+      "Group"
+    ]
+  },
+  "gitHead": "4551d9f3aa78a58ae8e754099b06dae2a3f7a2f2"
 }

README.md

@@ -1,13 +0,58 @@
-## Radio
+<!-- autogenerated don't modify -->
 
-The `<Radio>` component displays a radio input and label text beside it. When clicked it selects the input and deselects any other radio input in its group.
+# @paprika/radio - 0.1.15
 
-### Installation
+## Description
 
-`> npm install --save @paprika/radio`
-or
-`> yarn add @paprika/radio`
+Radio component displays a radio input and label text beside it. When clicked it selects the input and deselects any other radio input in its group
 
-### Usage
+## Installation
 
+```
+yarn add @paprika/radio
+```
+
+or with npm:
+
+```
+npm install @paprika/radio
+```
+
+## Props
+
+### Radio
+
+| Prop             | Type               | required | default           | Description                                                |
+| ---------------- | ------------------ | -------- | ----------------- | ---------------------------------------------------------- |
+| a11yText         | string             | false    | null              | Used for aria-label on the radio input                     |
+| ariaDescribedBy  | string             | false    | null              | Used for aria-describedby on the radio input               |
+| canDeselect      | bool               | false    | false             | Describe if the radio started as selected or not           |
+| children         | node               | false    | null              | Used for label contents                                    |
+| isChecked        | bool               | false    | false             |                                                            |
+| isDisabled       | bool               | false    | false             | Describe if the radio is disabled or not                   |
+| defaultIsChecked | bool               | false    | false             | Describe if the radio started as checked or not            |
+| name             | string             | false    | ""                | Name provided for accessibility                            |
+| onClick          | custom             | false    | () => {}          | onClick provided by parent Group component                 |
+| size             | ShirtSizes.DEFAULT | false    | ShirtSizes.MEDIUM | Size provided by parent Group component                    |
+| tabIndex         | union              | false    | 0                 | Value for tabindex attribute to override the default of 0. |
+| value            | string             | false    | ""                | Value applied to the input if needed.                      |
+
+### Radio.Group
+
+| Prop        | Type               | required | default           | Description                                          |
+| ----------- | ------------------ | -------- | ----------------- | ---------------------------------------------------- |
+| a11yText    | string             | false    | ""                | aria-labelledby prop on the containing group element |
+| canDeselect | bool               | false    | false             | Can deselect any radio                               |
+| children    | node               | false    | null              | The individual radio items.                          |
+| isDisabled  | bool               | false    | false             | Are all radios disabled                              |
+| onChange    | func               | true     | -                 | On change of radio selection.                        |
+| size        | ShirtSizes.DEFAULT | false    | ShirtSizes.MEDIUM | The size for all radio components.                   |
+
+## Usage
+
+<!-- autogenerated don't modify -->
+<!-- content -->
+
+## Usage
+
 ```js
@@ -28,26 +73,9 @@ import Radio from "@paprika/radio";
 
-### Props
+<!-- eoContent -->
 
-#### Radio.Group
+#### more:
 
--a11yText
--canDeselect
--children
--isDisabled
--onChange
--size
--tabIndex
-
-[More detail about these props](https://github.com/acl-services/paprika/blob/master/packages/Radio/src/components/Group/Group.js)
-
-#### Radio
-
--a11yText
--ariaDescribedBy
--canDeselect
--children
--isChecked
--isDisabled
--defaultIsChecked
-
-[More detail about these props](https://github.com/acl-services/paprika/blob/master/packages/Radio/src/Radio.js)
+- [Storybook showcase](https://paprika.highbond.com/?path=/story/radio--showcase)
+- [Github source code](https://github.com/acl-services/paprika/tree/master/packages/Radio/src)
+- [Github create issue](https://github.com/acl-services/paprika/issues/new?label=[]&title=@paprika/radio%20[help]:%20your%20short%20description&body=%0A%23%20Help%20wanted%0A%0A%23%23%20Please%20write%20your%20question.%0A*A%20clear%20and%20concise%20description%20of%20what%20the%20question%20is*%0A%0A%23%23%20Additional%20context%0A*Add%20any%20other%20context%20or%20screenshots%20about%20your%20question%20here.*%0A)
+- [ChangeLog](https://github.com/acl-services/paprika/tree/master/packages/Radio/CHANGELOG.md)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47609

increased by7.98%

Number of lines in readme file

81

increased by52.83%

Dependency changes

• Updated@paprika/icon@^0.3.2