svelte-skeleton

KO | EN

gitlite — search

#javascript #php #nodejs #python #angularjs #theme #linux #hacktoberfest #blog #ruby #r #arduino

svelte-skeleton

★ 46 Open GitHub ↗

Simple implementation of SVG skeletons in Svelte 3 :cat:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# svelte-skeleton

[![NPM version](https://img.shields.io/npm/v/svelte-skeleton.svg?style=flat)](https://www.npmjs.com/package/svelte-skeleton) [![NPM downloads](https://img.shields.io/npm/dm/svelte-skeleton.svg?style=flat)](https://www.npmjs.com/package/svelte-skeleton) [![Svelte v3](https://img.shields.io/badge/svelte-v3-blueviolet.svg)](https://svelte.dev)

Simple implementation of SVG skeletons in Svelte 3

![example](https://user-images.githubusercontent.com/25938785/90191444-8f443b80-ddc9-11ea-918f-da77070549b8.gif)

## :rocket: Features

This is Svelte's component to create custom SVG skeletons to improve level of UX of loading images and interface.

- Easy to use (Svelte component allow to use any SVG forms, such as `<rect />` and `<circle />`)
- Fully customizable: you can adjust the colors, sizes and speed :t-rex:
- Works fine with SSR
- Light size :fire:
- Pure SVG: any custom SVG shapes can be used
- All backgrounds within one Svelte component will be synchronized

P.S. It's recommended to use this package only for middle or large images. If you want to achieve the best UX for icons, use this package with `animate = false`. Also you can use [svelte-image-loader](https://github.com/denisstasyev/svelte-image-loader) ([NPM package](https://www.npmjs.com/package/svelte-image-loader)) to smooth the moment the image appears.

## Install

```bash
npm i svelte-skeleton
```

## Usage

Please note that you should import `.svelte` file to compile it with your project's Svelte version (you can use compiled `svelte-skeleton/index.js`, but there could be errors with different versions of Svelte in your project and in this package)

```html
<script>
  import Skeleton from 'svelte-skeleton/Skeleton.svelte'

...
</script>

</Skeleton>
```

Also you can combine it with Svelte's `{#await ...}`:

```html
{#await promise}

<Skeleton height="360" width="360">
  <rect width="96" height="72" x="0" y="0" rx="12" ry="12" />
  <rect width="260" height="10" x="108" y="19" rx="5" ry="5" />
  <rect width="150" height="10" x="108" y="43" rx="5" ry="5" />
</Skeleton>
{:then value}

<YourCoolComponent {value} />
{:catch error}

<Error title="{error.message}" />
{/await}
```

## API

### Parameters

| Name                       | Type    | Default     | Description                        |
| -------------------------- | ------- | ----------- | ---------------------------------- |
| primaryColor               | string  | `'#ebecef'` | Main background color              |
| secondaryColor             | string  | `'#f5f5f7'` | Animation line color               |
| height                     | number  | `200`       |                                    |
| width                      | number  | `400`       |                                    |
| speed                      | number  | `2`         |                                    |
| animate                    | boolean | `true`      |                                    |
| secondaryColorPercentWidth | number  | `100`       | Initial secondaryColor-part offset |
| ariaLabel                  | string  | `null`      | Aria Label                         |

Please note that some older browsers (like Internet Explorer 11) do not support SVG animations. They will only show the background color without the animation line. To create skeletons for these browsers, you need to write your own CSS animations.

## License

svelte-skeleton

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README