@spark-ui/spinner 2.2.0 → 2.2.1

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +6 -6
  3. package/dist/Spinner.d.ts +3 -0
  4. package/dist/public/docgen.json +4 -4
  5. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -3,6 +3,13 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [2.2.1](https://github.com/adevinta/spark/compare/@spark-ui/spinner@2.2.0...@spark-ui/spinner@2.2.1) (2023-12-05)
7
+
8
+ ### Bug Fixes
9
+
10
+ - doc ([5506203](https://github.com/adevinta/spark/commit/55062039dc67c3532be42a4661540052094163d9))
11
+ - **spinner:** doc ([d56a04e](https://github.com/adevinta/spark/commit/d56a04ee3e19c3b516d7fb18c2b18324318f6375))
12
+
6
13
  # [2.2.0](https://github.com/adevinta/spark/compare/@spark-ui/spinner@2.1.7...@spark-ui/spinner@2.2.0) (2023-09-28)
7
14
 
8
15
  ### Features
package/README.md CHANGED
@@ -1,13 +1,13 @@
1
1
  # Spinner
2
2
  > @spark-ui/spinner
3
3
 
4
- ![storybook](https://img.shields.io/badge/storybook-black?logo=storybook&link=https%3A%2F%2Fsparkui.vercel.app%2F%3Fpath%3D%2Fdocs%2Fcomponents-spinner--docs)
5
- ![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs&link=https%3A%2F%2Fsparkui-adv.vercel.app%2Fdocs%2Fcomponents%2Fspinner)
6
- ![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%2Fnew%3F%26projects%3D4%26template%3Dbug-report.yml%26assignees%3D%26labels%3Dcomponent%2Cspinner)
7
- ![npm](https://img.shields.io/npm/dt/%40spark-ui/spinner?logo=npm&labelColor=black&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40spark-ui%2Fspinner)
4
+ [![storybook](https://img.shields.io/badge/storybook-black?logo=storybook)](https://sparkui.vercel.app/?path=/docs/components-spinner--docs)
5
+ [![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs)](https://sparkui-adv.vercel.app/docs/components/spinner)
6
+ [![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red)](https://github.com/adevinta/spark/issues/new?&projects=4&template=bug-report.yml&assignees=&labels=component,spinner)
7
+ [![npm](https://img.shields.io/npm/dt/%40spark-ui/spinner?logo=npm&labelColor=black)](https://www.npmjs.com/package/@spark-ui/spinner)
8
8
 
9
9
 
10
10
  This package is part of the [`@spark-ui`](https://github.com/adevinta/spark) react-js user interface component library project.
11
11
 
12
- ![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Acomponent%20label%3Aspinner&logo=openbugbounty&logoColor=red&label=issues%20open&color=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%3Fq%3Dis%253Aopen%2Blabel%253Acomponent%2Blabel%253Aspinner)
13
- ![NPM](https://img.shields.io/npm/l/%40spark-ui%2Fspinner)
12
+ [![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Acomponent%20label%3Aspinner&logo=openbugbounty&logoColor=red&label=issues%20open&color=red)](https://github.com/adevinta/spark/issues?q=is%3Aopen+label%3Acomponent+label%3Aspinner)
13
+ [![NPM](https://img.shields.io/npm/l/%40spark-ui%2Fspinner)](https://github.com/adevinta/spark/blob/main/packages/components/spinner/LICENSE.md)
package/dist/Spinner.d.ts CHANGED
@@ -1,6 +1,9 @@
1
1
  import { ComponentPropsWithoutRef } from 'react';
2
2
  import { SpinnerStylesProps } from './Spinner.styles';
3
3
  export interface SpinnerProps extends ComponentPropsWithoutRef<'div'>, SpinnerStylesProps {
4
+ /**
5
+ * Use `label` prop for accessibility, it is important to add a fallback loading text. This text will be visible to screen readers.
6
+ */
4
7
  label?: string;
5
8
  }
6
9
  export declare const Spinner: import("react").ForwardRefExoticComponent<SpinnerProps & {
package/dist/public/docgen.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "props": {
8
8
  "label": {
9
9
  "defaultValue": null,
10
- "description": "",
10
+ "description": "Use `label` prop for accessibility, it is important to add a fallback loading text. This text will be visible to screen readers.",
11
11
  "name": "label",
12
12
  "parent": {
13
13
  "fileName": "spinner/src/Spinner.tsx",
@@ -28,7 +28,7 @@
28
28
  "defaultValue": {
29
29
  "value": "current"
30
30
  },
31
- "description": "",
31
+ "description": "Use `size` prop to set the size of the spinner. If you want to set the full size for the spinner, don't forget to add a wrapping container with its own size.",
32
32
  "name": "size",
33
33
  "declarations": [],
34
34
  "required": false,
@@ -55,7 +55,7 @@
55
55
  "defaultValue": {
56
56
  "value": "current"
57
57
  },
58
- "description": "",
58
+ "description": "Color scheme of the spinner.",
59
59
  "name": "intent",
60
60
  "declarations": [],
61
61
  "required": false,
@@ -98,7 +98,7 @@
98
98
  },
99
99
  "isBackgroundVisible": {
100
100
  "defaultValue": null,
101
- "description": "",
101
+ "description": "Size of the button.",
102
102
  "name": "isBackgroundVisible",
103
103
  "declarations": [],
104
104
  "required": false,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spark-ui/spinner",
3
- "version": "2.2.0",
3
+ "version": "2.2.1",
4
4
  "description": "Spinners provide a visual cue that an action is processing awaiting a course of change or a result.",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -47,5 +47,5 @@
47
47
  },
48
48
  "homepage": "https://sparkui.vercel.app",
49
49
  "license": "MIT",
50
- "gitHead": "60a8f00aef92177084ac744bc4fd56ef13bc9948"
50
+ "gitHead": "e2fd654d551c09971906b3b0036f9a385369bb7a"
51
51
  }