@nimbus-ds/radio 2.3.0-rc.2 → 2.3.0-rc.5

package/dist/CHANGELOG.md

@@ -0,0 +1,75 @@
+# Changelog
+
+Use radios when a user needs to select one option from a list.
+
+## 2023-12-22 `2.2.1`
+
+- Update component with new color tokens from `@nimbus-ds/tokens` package. ([#215](https://github.com/TiendaNube/nimbus-design-system/pull/215) by [@juanchigallego](https://github.com/juanchigallego))
+
+## 2023-03-13 `2.2.0`
+
+### 💡 Others
+
+- Refactored style classes to have more semantic names. ([#110](https://github.com/TiendaNube/nimbus-design-system/pull/110) by [@juniorconquista](https://github.com/juniorconquista))
+
+## 2023-02-23 `2.1.0`
+
+### 🎉 New features
+
+- Added server side-rendering support to component. ([#105](https://github.com/TiendaNube/nimbus-design-system/pull/105) by [@juniorconquista](https://github.com/juniorconquista))
+
+## 2023-02-07 `2.0.1`
+
+### 🐛 Bug fixes
+
+- Fixed component rendering when there is no label to display. ([#80](https://github.com/TiendaNube/nimbus-design-system/pull/80) by [@juniorconquista](https://github.com/juniorconquista))
+
+## 2022-12-22 `2.0.0`
+
+### 💡 Others
+
+- Removed direct dependency on `nimbus-ds/styles` package from component build. ([#69](https://github.com/TiendaNube/nimbus-design-system/pull/69) by [@juniorconquista](https://github.com/juniorconquista))
+
+## 2022-12-16 `1.1.1`
+
+### 🎉 New features
+
+- Update label font size on `as: button` variant. ([#67](https://github.com/TiendaNube/nimbus-design-system/pull/67) by [@juanchigallego](https://github.com/juanchigallego))
+
+## 2022-12-07 `1.1.0`
+
+### 🎉 New features
+
+- Changed build build to consume inner package `@nimbus-ds/webpack`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+
+### 📚 3rd party library updates
+
+- Removed `terser-webpack-plugin@5.3.5`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+- Removed `ts-loader@9.3.1`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+- Removed `webpack-cli@4.10.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+- Removed `webpack@5.74.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+- Removed `typescript@4.7.4`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+
+## 2022-12-02 `1.0.1`
+
+### 🐛 Bug fixes
+
+- Fixed minimum size of radio and lineHeight of label. ([#62](https://github.com/TiendaNube/nimbus-design-system/pull/62) by [@juniorconquista](https://github.com/juniorconquista))
+
+## 2022-10-05 `1.0.0`
+
+### 📚 3rd party library updates
+
+- Added `terser-webpack-plugin@5.3.5`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added `ts-loader@9.3.1`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added `typescript@4.7.4`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added `webpack@5.74.0`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added `webpack-cli@4.10.0`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+
+### 🎉 New features
+
+- Added `name`, `as`, `checked`, `disabled` and `label` properties to the Component. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added stories on Component. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Created new `Radio.Skeleton` subcomponent. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added `width`, `as` and `data-testid` properties to the Component `Radio.Skeleton`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))
+- Added stories on Component `Radio.Skeleton`. ([#36](https://github.com/TiendaNube/nimbus-design-system/pull/36) by [@juniorconquista](https://github.com/juniorconquista))

package/dist/README.md

@@ -0,0 +1,62 @@
+# `@nimbus-ds/radio`
+
+[![@nimbus-ds/radio](https://img.shields.io/npm/v/@nimbus-ds/radio?radio=%40nimbus-ds%2Fradio)](https://www.npmjs.com/package/@nimbus-ds/radio)
+
+The Radio component allows us to choose a single option within a selection list.
+
+## Installation
+
+```sh
+$ yarn add @nimbus-ds/radio
+# or
+$ npm install @nimbus-ds/radio
+```
+
+### Component Anatomy
+
+The component is composed of a bullet or selection button with their respective states, in addition to a label that displays the content referring to the option.
+
+## Guidelines
+
+We use this component when we need the user to enter information in a form, checking a single option within a list of up to 7 items.
+
+### Radio default
+
+This variant has less visual prominence, so it can be used in vertical selection lists, such as in settings or registration forms.
+
+### Radio button
+
+This variant has more visual prominence, so it can be used in horizontal lists as criteria within a data filter.
+
+### Possible states
+
+The component has 3 states, which can be used according to the context and need of the application.
+
+- Rest - is used to represent an unselected option
+- Checked - is used to represent a selected option
+- Disabled - is used to represent that an option is disabled, this state can be combined with the previous 2
+
+### Labels
+
+The component must always be accompanied by a label that clearly describes the option represented, always starting with the first capital letter, and sentences must never end in a semicolon. The options must be sorted using a specific logical criteria (alphabetic, numerical, temporal, etc.).
+
+### Aria Label
+
+To facilitate navigation for people with some kind of visual or cognitive limitation, this component has a tag (Aria Label) to inform the current status of the Radio.
+
+### Recommendation for use
+
+- Selection of items in lists where the choice is mandatory
+- Select a single setting from a list of options
+
+### Related components
+
+- Select - Can be used to select a single option from a list of more than 7 items
+- Toggle - Can be used to toggle binary options on and off
+- Checkbox - Can be used to select multiple options from a list
+
+## Usage
+
+View docs [here](https://nimbus.nuvemshop.com.br/documentation/atomic-components/radio).
+
+<img alt="Nimbus" style="margin-bottom: 30px;" src="https://tiendanube.github.io/design-system-nimbus/static/media/nimbus-logo.ab60bd79.png" height="30" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimbus-ds/radio",
-  "version": "2.3.0-rc.2",
+  "version": "2.3.0-rc.5",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [
@@ -14,8 +14,8 @@
     "version": "yarn version"
   },
   "dependencies": {
-    "@nimbus-ds/skeleton": "^3.1.0-rc.2",
-    "@nimbus-ds/text": "^6.4.0-rc.2"
+    "@nimbus-ds/skeleton": "^3.1.0-rc.5",
+    "@nimbus-ds/text": "^6.4.0-rc.5"
   },
   "peerDependencies": {
     "react": "^16.8 || ^17.0 || ^18.0",
@@ -30,7 +30,7 @@
     "url": "https://github.com/TiendaNube/nimbus-design-system/issues"
   },
   "devDependencies": {
-    "@nimbus-ds/webpack": "^1.4.0"
+    "@nimbus-ds/webpack": "^1.5.0-rc.1"
   },
   "stableVersion": "2.2.1"
 }