From 03e8437a2fa9b76e6ca11cab36a78d3ecb90b389 Mon Sep 17 00:00:00 2001 From: nikbabchenko Date: Thu, 22 Oct 2020 21:08:29 +0300 Subject: [PATCH] Remove classnames (#7) * feat(bumps version to 1.0.5): removed classnames, bumps version to 1.0.5 Removes classnames, bumps version to 1.0.5 * docs(docs changes): minor docs changes Co-authored-by: Mykola Babchenko --- CHANGELOG.md | 2 +- package.json | 2 +- readme.md | 8 ++++---- src/components/skeleton/readme.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2531007..7fe1a5b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. -## 2.0.0 (2020-10-21) +## 1.0.5 (2020-10-22) ### ⚠ BREAKING CHANGES diff --git a/package.json b/package.json index cee6a7a..3218a26 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "skeleton-webcomponent-loader", - "version": "2.0.0", + "version": "1.0.5", "description": "Skeleton loader webcomponent developed in stencil.js", "main": "dist/index.cjs.js", "module": "dist/custom-elements/index.js", diff --git a/readme.md b/readme.md index 9f6e8e9..42bcac0 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,7 @@ # Skeleton Loader Webcomponent ![Variants](https://skeleton-webcomponent-loader.web.app/images/variants.gif) -**Skeleton Loader** is a very lightweight (**5.2kb** gzip / **10kb** without compression) webcomponent to make beautiful, animated loading skeletons in any web app - pure html/css/js or Angular/React. +**Skeleton Loader** is a very lightweight (less than **5kb** gzip) webcomponent to make beautiful, animated loading skeletons in any web app - pure html/css/js or Angular/React. > Spinners and loaders have traditionally been the way to tell users > that content is going to take a while to load. While this approach is @@ -26,8 +26,8 @@ You can get it on NPM installing `skeleton-webcomponent-loader` as a project npm i skeleton-webcomponent-loader #### Script tag via UNPKG (global npm delivery network) - - + + #### Script tag via npm @@ -67,7 +67,7 @@ Pass properties and see it in action | -------------- | --------------- | ------------------------------------------------------------------- | ----------------------------------------------------- | ------------ | | `animation` | `animation` | Animation type | `"false" | "progress" | "progress-dark" | "pulse"` | `'progress'` | | `count` | `count` | Number of rows of current skeleton type | `number` | `1` | -| `customStyles` | `custom-styles` | Custom css styles (background/margins/width/height etc.) | `string | { [k: string]: string; }` | `{}` | +| `customStyles` | `custom-styles` | Custom css styles (background/margins/width/height etc.) | `string | { [key: string]: string; }` | `{}` | | `height` | `height` | Height of the skeleton ex. 100px, 100%, auto etc. | `string` | `null` | | `showWarnings` | `show-warnings` | Whether to show warnings for the wrong animation type/custom styles | `boolean` | `true` | | `variant` | `variant` | Variant of the skeleton - circle or row | `"circle" | "rect" | "text"` | `'text'` | diff --git a/src/components/skeleton/readme.md b/src/components/skeleton/readme.md index 63c672b..0d27946 100644 --- a/src/components/skeleton/readme.md +++ b/src/components/skeleton/readme.md @@ -11,7 +11,7 @@ | -------------- | --------------- | ------------------------------------------------------------------- | ----------------------------------------------------- | ------------ | | `animation` | `animation` | Animation type | `"false" \| "progress" \| "progress-dark" \| "pulse"` | `'progress'` | | `count` | `count` | Number of rows of current skeleton type | `number` | `1` | -| `customStyles` | `custom-styles` | Custom css styles (background/margins/width/height etc.) | `string \| { [k: string]: string; }` | `{}` | +| `customStyles` | `custom-styles` | Custom css styles (background/margins/width/height etc.) | `string \| { [key: string]: string; }` | `{}` | | `height` | `height` | Height of the skeleton ex. 100px, 100%, auto etc. | `string` | `null` | | `showWarnings` | `show-warnings` | Whether to show warnings for the wrong animation type/custom styles | `boolean` | `true` | | `variant` | `variant` | Variant of the skeleton - circle or row | `"circle" \| "rect" \| "text"` | `'text'` |