@atlaskit/spinner
Advanced tools
Comparing version 4.0.2 to 4.0.3
217
CHANGELOG.md
@@ -1,105 +0,55 @@ | ||
<a name="4.0.2"></a> | ||
## 4.0.2 (2017-10-26) | ||
# @atlaskit/spinner | ||
## 4.0.3 | ||
<a name="4.0.2"></a> | ||
## 4.0.2 (2017-10-26) | ||
* bug fix; fix to rebuild stories ([793b2a7](https://bitbucket.org/atlassian/atlaskit/commits/793b2a7)) | ||
### Bug Fixes | ||
* **stories:** fix to rebuild stories ([793b2a7](https://bitbucket.org/atlassian/atlaskit/commits/793b2a7)) | ||
<a name="4.0.1"></a> | ||
## 4.0.1 (2017-10-22) | ||
* bug fix; update styled-components dep and react peerDep ([6a67bf8](https://bitbucket.org/atlassian/atlaskit/commits/6a67bf8)) | ||
## 4.0.0 (2017-08-29) | ||
### Bug Fixes | ||
* **component:** update styled-components dep and react peerDep ([6a67bf8](https://bitbucket.org/atlassian/atlaskit/commits/6a67bf8)) | ||
* breaking; convert spinner to have a dark mode implementation ([b1c2a53](https://bitbucket.org/atlassian/atlaskit/commits/b1c2a53)) | ||
* breaking; convert spinner to have a dark mode implementation (issues closed: #ak-3371) ([b1c2a53](https://bitbucket.org/atlassian/atlaskit/commits/b1c2a53)) | ||
<a name="4.0.0"></a> | ||
# 4.0.0 (2017-08-29) | ||
### Features | ||
* **component:** convert spinner to have a dark mode implementation ([b1c2a53](https://bitbucket.org/atlassian/atlaskit/commits/b1c2a53)) | ||
### BREAKING CHANGES | ||
* **component:** convert spinner to have a dark mode implementation | ||
ISSUES CLOSED: #AK-3371 | ||
<a name="3.4.2"></a> | ||
## 3.4.2 (2017-07-27) | ||
### Bug Fixes | ||
* fix; rename jsnext:main to jsnext:experimental:main temporarily ([c7508e0](https://bitbucket.org/atlassian/atlaskit/commits/c7508e0)) | ||
* **package:** rename jsnext:main to jsnext:experimental:main temporarily ([c7508e0](https://bitbucket.org/atlassian/atlaskit/commits/c7508e0)) | ||
<a name="3.4.1"></a> | ||
## 3.4.1 (2017-07-25) | ||
### Bug Fixes | ||
* fix; use class transform in loose mode in babel to improve load performance in apps ([fde719a](https://bitbucket.org/atlassian/atlaskit/commits/fde719a)) | ||
* **build:** use class transform in loose mode in babel to improve load performance in apps ([fde719a](https://bitbucket.org/atlassian/atlaskit/commits/fde719a)) | ||
## 3.1.0 (2017-07-17) | ||
## 3.1.0 (2017-07-17) | ||
## 3.1.0 (2017-07-17) | ||
<a name="3.1.0"></a> | ||
# 3.1.0 (2017-07-17) | ||
* fix; rerelease, failed prepublish scripts ([5fd82f8](https://bitbucket.org/atlassian/atlaskit/commits/5fd82f8)) | ||
## 3.1.0 (2017-07-17) | ||
<a name="3.1.0"></a> | ||
# 3.1.0 (2017-07-17) | ||
* feature; added ES module builds to dist and add jsnext:main to most ADG packages ([ea76507](https://bitbucket.org/atlassian/atlaskit/commits/ea76507)) | ||
## 3.0.0 (2017-07-07) | ||
<a name="3.1.0"></a> | ||
# 3.1.0 (2017-07-17) | ||
* fix; refactor spinner to use TransitionGroup ([e0cef25](https://bitbucket.org/atlassian/atlaskit/commits/e0cef25)) | ||
### Bug Fixes | ||
* **package:** rerelease, failed prepublish scripts ([5fd82f8](https://bitbucket.org/atlassian/atlaskit/commits/5fd82f8)) | ||
<a name="3.1.0"></a> | ||
# 3.1.0 (2017-07-17) | ||
### Features | ||
* **package:** added ES module builds to dist and add jsnext:main to most ADG packages ([ea76507](https://bitbucket.org/atlassian/atlaskit/commits/ea76507)) | ||
<a name="3.0.0"></a> | ||
# 3.0.0 (2017-07-07) | ||
### Bug Fixes | ||
* **refactor:** refactor spinner to use TransitionGroup ([e0cef25](https://bitbucket.org/atlassian/atlaskit/commits/e0cef25)) | ||
### BREAKING CHANGES | ||
* **refactor:** remove typescript interface file. when a spinner's isCompleting props is true and it has finished | ||
* breaking; remove typescript interface file. when a spinner's isCompleting props is true and it has finished | ||
its exit animation it will not longer take up space in the DOM. | ||
@@ -109,173 +59,88 @@ | ||
<a name="2.2.5"></a> | ||
## 2.2.5 (2017-06-28) | ||
### Bug Fixes | ||
* fix; triggering component release with previous fix ([20a9e93](https://bitbucket.org/atlassian/atlaskit/commits/20a9e93)) | ||
* **component:** triggering component release with previous fix ([20a9e93](https://bitbucket.org/atlassian/atlaskit/commits/20a9e93)) | ||
<a name="2.2.4"></a> | ||
## 2.2.4 (2017-06-27) | ||
### Bug Fixes | ||
* fix; fix Spinner onComplete invocation on Edge ([e998791](https://bitbucket.org/atlassian/atlaskit/commits/e998791)) | ||
* **component:** fix Spinner onComplete invocation on Edge ([e998791](https://bitbucket.org/atlassian/atlaskit/commits/e998791)) | ||
<a name="2.2.3"></a> | ||
## 2.2.3 (2017-05-29) | ||
### Bug Fixes | ||
* fix; add index shim for unit tests ([838c743](https://bitbucket.org/atlassian/atlaskit/commits/838c743)) | ||
* fix; add prop-types as a dependency to avoid React 15.x warnings ([92598eb](https://bitbucket.org/atlassian/atlaskit/commits/92598eb)) | ||
* **component:** add index shim for unit tests ([838c743](https://bitbucket.org/atlassian/atlaskit/commits/838c743)) | ||
* **package:** add prop-types as a dependency to avoid React 15.x warnings ([92598eb](https://bitbucket.org/atlassian/atlaskit/commits/92598eb)) | ||
<a name="2.2.2"></a> | ||
## 2.2.2 (2017-05-25) | ||
### Bug Fixes | ||
* fix; update util-shared-styles dependency in spinner ([603a1c1](https://bitbucket.org/atlassian/atlaskit/commits/603a1c1)) | ||
* **package:** update util-shared-styles dependency in spinner ([603a1c1](https://bitbucket.org/atlassian/atlaskit/commits/603a1c1)) | ||
<a name="2.2.1"></a> | ||
## 2.2.1 (2017-05-08) | ||
### Bug Fixes | ||
* fix; removes spinner in button story from storybook ([96ed0f8](https://bitbucket.org/atlassian/atlaskit/commits/96ed0f8)) | ||
* **stories:** removes spinner in button story from storybook ([96ed0f8](https://bitbucket.org/atlassian/atlaskit/commits/96ed0f8)) | ||
## 2.2.0 (2017-05-06) | ||
* feature; add invertColor prop to Spinner to enable it to be used on dark backgrounds ([4981617](https://bitbucket.org/atlassian/atlaskit/commits/4981617)) | ||
<a name="2.2.0"></a> | ||
# 2.2.0 (2017-05-06) | ||
## 2.1.0 (2017-05-02) | ||
### Features | ||
* feature; adds delay prop to Spinner for custom delays before showing spinner ([98679b7](https://bitbucket.org/atlassian/atlaskit/commits/98679b7)) | ||
* feature; fixes issue where long delays would remove the spin-in animation ([240bea9](https://bitbucket.org/atlassian/atlaskit/commits/240bea9)) | ||
* **component:** add invertColor prop to Spinner to enable it to be used on dark backgrounds ([4981617](https://bitbucket.org/atlassian/atlaskit/commits/4981617)) | ||
<a name="2.1.0"></a> | ||
# 2.1.0 (2017-05-02) | ||
### Features | ||
* **component:** adds delay prop to Spinner for custom delays before showing spinner ([98679b7](https://bitbucket.org/atlassian/atlaskit/commits/98679b7)) | ||
* **component:** fixes issue where long delays would remove the spin-in animation ([240bea9](https://bitbucket.org/atlassian/atlaskit/commits/240bea9)) | ||
<a name="2.0.3"></a> | ||
## 2.0.3 (2017-04-27) | ||
### Bug Fixes | ||
* fix; update legal copy to be more clear. Not all modules include ADG license. ([f3a945e](https://bitbucket.org/atlassian/atlaskit/commits/f3a945e)) | ||
* **docs:** update legal copy to be more clear. Not all modules include ADG license. ([f3a945e](https://bitbucket.org/atlassian/atlaskit/commits/f3a945e)) | ||
<a name="2.0.2"></a> | ||
## 2.0.2 (2017-04-26) | ||
### Bug Fixes | ||
* fix; update legal copy and fix broken links for component README on npm. New contribution and ([0b3e454](https://bitbucket.org/atlassian/atlaskit/commits/0b3e454)) | ||
* **docs:** update legal copy and fix broken links for component README on npm. New contribution and ([0b3e454](https://bitbucket.org/atlassian/atlaskit/commits/0b3e454)) | ||
<a name="2.0.1"></a> | ||
## 2.0.1 (2017-03-28) | ||
### Bug Fixes | ||
* fix; remove [@atlaskit](https://github.com/atlaskit)/spinner from same package devDependencies ([2eac9f0](https://bitbucket.org/atlassian/atlaskit/commits/2eac9f0)) | ||
* **component:** remove [@atlaskit](https://github.com/atlaskit)/spinner from same package devDependencies ([2eac9f0](https://bitbucket.org/atlassian/atlaskit/commits/2eac9f0)) | ||
## 2.0.0 (2017-03-27) | ||
* fix; address IE focus management issue ([acad36d](https://bitbucket.org/atlassian/atlaskit/commits/acad36d)) | ||
<a name="2.0.0"></a> | ||
# 2.0.0 (2017-03-27) | ||
null refactor the spinner component to use styled-components ([155956c](https://bitbucket.org/atlassian/atlaskit/commits/155956c)) | ||
### Bug Fixes | ||
* **refactor:** address IE focus management issue ([acad36d](https://bitbucket.org/atlassian/atlaskit/commits/acad36d)) | ||
* breaking; removed dependency \ as dependency \| added dependency \ \| | ||
### Code Refactoring | ||
* **refactor:** refactor the spinner component to use styled-components ([155956c](https://bitbucket.org/atlassian/atlaskit/commits/155956c)) | ||
### BREAKING CHANGES | ||
* **refactor:** removed dependency \ as dependency \| added dependency \ \| | ||
added peerDependency of \ | ||
<a name="1.0.5"></a> | ||
## 1.0.5 (2017-03-22) | ||
### Bug Fixes | ||
* fix; remove spinner delay when removing component ([5c2ebcf](https://bitbucket.org/atlassian/atlaskit/commits/5c2ebcf)) | ||
* **component:** remove spinner delay when removing component ([5c2ebcf](https://bitbucket.org/atlassian/atlaskit/commits/5c2ebcf)) | ||
<a name="1.0.3"></a> | ||
## 1.0.3 (2017-03-21) | ||
<a name="1.0.3"></a> | ||
## 1.0.3 (2017-03-21) | ||
### Bug Fixes | ||
* fix; maintainers for all the packages were added ([261d00a](https://bitbucket.org/atlassian/atlaskit/commits/261d00a)) | ||
* **package:** maintainers for all the packages were added ([261d00a](https://bitbucket.org/atlassian/atlaskit/commits/261d00a)) | ||
<a name="1.0.2"></a> | ||
## 1.0.2 (2017-03-03) | ||
### Bug Fixes | ||
* fix; adds a 100ms delay before showing the spinner ([90d9a47](https://bitbucket.org/atlassian/atlaskit/commits/90d9a47)) | ||
* fix; minor docs/storybook updates to be more in line with the rest of the Atlaskit patterns ([83a0af1](https://bitbucket.org/atlassian/atlaskit/commits/83a0af1)) | ||
* **component:** adds a 100ms delay before showing the spinner ([90d9a47](https://bitbucket.org/atlassian/atlaskit/commits/90d9a47)) | ||
* **docs:** minor docs/storybook updates to be more in line with the rest of the Atlaskit patterns ([83a0af1](https://bitbucket.org/atlassian/atlaskit/commits/83a0af1)) | ||
<a name="1.0.1"></a> | ||
## 1.0.1 (2017-02-07) | ||
### Bug Fixes | ||
* **bump:** Updates package to use scoped ak packages ([aa32414](https://bitbucket.org/atlassian/atlaskit/commits/aa32414)) | ||
* fix; Updates package to use scoped ak packages ([aa32414](https://bitbucket.org/atlassian/atlaskit/commits/aa32414)) |
{ | ||
"name": "@atlaskit/spinner", | ||
"version": "4.0.2", | ||
"config": { | ||
"access": "public" | ||
}, | ||
"version": "4.0.3", | ||
"description": "A React component that displays a spinning icon to show a loading state", | ||
"main": "dist/bundle.js", | ||
"webpack": "dist/bundle-cjs.js", | ||
"jsnext:experimental:main": "dist/es/index.js", | ||
"ak:webpack:raw": "src/index.jsx", | ||
"ak:component": { | ||
"name": "Spinner", | ||
"dark": true | ||
}, | ||
"scripts": { | ||
"eslint": "../../build/bin/lint.eslint.sh", | ||
"jest": "echo 'yarn run jest is deprecated and removed. please run yarn run test:unit instead.'", | ||
"prepublish": "../../node_modules/.bin/in-publish && { cd ../.. && npm run prepublish-with-babel/single @atlaskit/spinner; } || ../../node_modules/.bin/not-in-publish", | ||
"storybook": "../../build/bin/storybook/run.local.js", | ||
"storybook:static": "../../build/bin/storybook/build.static.js", | ||
"test:unit": "../../node_modules/.bin/jest -c ../../build/config/jest.config.js" | ||
}, | ||
"types": "src/index.d.ts", | ||
"license": "Apache-2.0", | ||
"main": "dist/cjs/index.js", | ||
"module": "dist/esm/index.js", | ||
"atlaskit:src": "src/index.js", | ||
"src": "src/index.js", | ||
"files": [ | ||
@@ -30,32 +15,27 @@ "dist" | ||
"maintainers": [ | ||
{ | ||
"name": "Luke B" | ||
} | ||
"Jared C", | ||
"Luke B" | ||
], | ||
"license": "Apache-2.0", | ||
"peerDependencies": { | ||
"react": "^15.3.2 || ^16.0.0" | ||
"atlaskit": { | ||
"name": "Spinner", | ||
"team": "elements" | ||
}, | ||
"repository": "bitbucket:atlaskit/atlaskit-mk2", | ||
"dependencies": { | ||
"@atlaskit/theme": "^2.0.0", | ||
"babel-runtime": "^6.11.6", | ||
"prop-types-extra": "^1.0.1", | ||
"prop-types": "^15.5.10", | ||
"react-transition-group": "^1.2.0", | ||
"@atlaskit/theme": "^2.2.5", | ||
"babel-runtime": "^6.26.0", | ||
"react-transition-group": "^2.2.1", | ||
"styled-components": "^1.4.6" | ||
}, | ||
"peerDependencies": { | ||
"react": "^15.6.1" | ||
}, | ||
"devDependencies": { | ||
"@atlaskit/button": "^3.0.0", | ||
"@atlaskit/spinner": "*", | ||
"@atlaskit/util-common-test": "^1.0.0", | ||
"@atlaskit/util-readme": "^1.0.0" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://bitbucket.org/atlassian/atlaskit" | ||
}, | ||
"keywords": [ | ||
"atlaskit", | ||
"ui" | ||
] | ||
} | ||
"@atlaskit/button": "^5.4.8", | ||
"@atlaskit/docs": "^0.0.5", | ||
"@atlaskit/spinner": "^4.0.3", | ||
"@atlaskit/util-shared-styles": "^2.10.3", | ||
"enzyme": "^2.9.1", | ||
"sinon": "^2.2.0" | ||
} | ||
} |
@@ -1,63 +0,10 @@ | ||
[![AtlasKit component registry](https://img.shields.io/badge/AtlasKit-components-FF5230.svg)](http://atlaskit.atlassian.com) | ||
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://Commitizen.github.io/cz-cli/) | ||
[![semantic-release](https://img.shields.io/badge/GitHub-semantic_release-ffab00.svg)](https://github.com/semantic-release/semantic-release) | ||
[![Report an issue](https://img.shields.io/badge/Report-an_issue-6554C0.svg)](http://go.atlassian.com/atlaskit-issues) | ||
# Tag | ||
# Spinner | ||
This component is displayed as an accessible tag with an optional link and/or | ||
button to remove it. | ||
Spinners are used for showing a system process of unknown length going on that ends with the system displaying results to the user. | ||
![Example tags](https://i.imgur.com/UPtxaIM.png) | ||
![Example spinner](https://i.imgur.com/jd0JSly.gif) | ||
## Try it out | ||
Interact with a [live demo of the @atlaskit/spinner component](https://aui-cdn.atlassian.com/atlaskit/stories/@atlaskit/spinner/4.0.2/). | ||
## Installation | ||
```sh | ||
npm install @atlaskit/spinner | ||
``` | ||
## Using the component | ||
Import the component in your React app as follows: | ||
``` | ||
import Spinner from '@atlaskit/spinner'; | ||
ReactDOM.render(<Spinner />, container); | ||
``` | ||
The spinner will display a loading in animation and then continue spinning until the `isCompleting` prop is set on it. | ||
If this prop is set to true the spinner will begin playing the outro animation (approximately 300ms). | ||
You can be notified once the animation is complete by hooking into the `onComplete` callback like so. | ||
```js | ||
import Spinner from '@atlaskit/spinner'; | ||
// some flag that we will set once our long running task is complete | ||
let loadingFinishedFlag = false; | ||
function loadingFinished() { | ||
// show our loaded content, etc | ||
} | ||
// this would normally be in a component or an app | ||
ReactDOM.render(<Spinner | ||
isCompleting={loadingFinishedFlag} | ||
onComplete={loadingFinished} | ||
/>); | ||
``` | ||
The result is a very smooth loading in and out animation that should feel seamless to the user. | ||
_* Please note that this module could have dependencies that are governed by the Atlassian Design Guidelines license which will be automatically included on install. Each dependency has a license file that indicates whether the Atlassian Design Guidelines license applies._ | ||
## We're here to help! | ||
Let us know what you think of our components and docs, your feedback is really important for us. | ||
Are you in trouble? Read through our [contribution guidelines](https://bitbucket.org/atlassian/atlaskit/src/HEAD/CONTRIBUTING.md) and raise an issue to us. | ||
Although the `tag` component can be used by itself, it works best in | ||
conjunction with the [`@atlskit/tag-group`](https://www.npmjs.com/package/@atlaskit/tag-group) | ||
component. |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
5
15
1
29060
6
431
11
1
1
+ Addedreact@18.3.1(transitive)
+ Addedreact-dom@18.3.1(transitive)
+ Addedreact-lifecycles-compat@3.0.4(transitive)
+ Addedreact-transition-group@2.9.0(transitive)
+ Addedscheduler@0.23.2(transitive)
- Removedprop-types@^15.5.10
- Removedprop-types-extra@^1.0.1
- Removedchain-function@1.0.1(transitive)
- Removedprop-types-extra@1.1.1(transitive)
- Removedreact@16.14.016.2.0(transitive)
- Removedreact-dom@16.14.0(transitive)
- Removedreact-transition-group@1.2.1(transitive)
- Removedscheduler@0.19.1(transitive)
- Removedwarning@3.0.04.0.3(transitive)
Updated@atlaskit/theme@^2.2.5
Updatedbabel-runtime@^6.26.0