@knekk/spinners
v0.0.21
Published
Pure css spinners made with simplicity in mind - Use directly as a single HTML element with the provided CSS, or import and use as a Vue component.
Downloads
48
Readme
Dev Components { Spinners }
Pure CSS spinners made with simplicity in mind - Use directly as a single HTML element or import and use as a Vue component. See demo for more spinners and usage instructions.
Installation
@knekki/spinners
doesn't need much of a setup. Just link the provided CSS in your HTML head element (or install via npm
), and use it as a single HTML element. You can also import it and use it as a Vue component.
HTML
<!-- Copy and paste the link below into your HTML head element -->
<link rel="stylesheet" type="text/css" href="https://unpkg.com/@knekk/[email protected]/dist/kSpinners.css">
Tip: This link will make all the spinners available to you. However, if you only want to use one of the spinners and care about filesize, it's recommended that you grab the CSS link specific to the spinner you choose. Swap
/kSpinners.css
part of the link with the name of the spinner. E.g if you want to use thekSpinnerSpin
spinner. Change the link to/kSpinnerSpin.css
etc.
Vue.js
If you are using Vue.js, you can instead choose to install the npm package and simply import the spinner component as you like.
# Install
npm install @knekk/spinners
Global registration
In your main.js
import Vue from 'vue'
import KSpinners from '@knekk/spinners'
Vue.use(KSpinners)
Local registration in your components
import { KSpinnerSpin, KSpinnerPulse, KSpinnerSwirl, KSpinnerSignal } from '@knekk/spinners'
export default {
components: {
KSpinnerSpin,
KSpinnerPulse,
KSpinnerSwirl,
KSpinnerSignal
}
}
Usage
Example: Assuming you want to use the KSpinnerSpin
spinner. Follow the steps below for your environment:
HTML
<!-- Copy and paste the spinner element where you want it in your HTML -->
<i class="k-spinner--spin"></i>
Vue.js
<!-- In SFC, string templates, and JSX -->
<KSpinnerSpin/>
<!-- Or in DOM templates -->
<k-spinner-spin></k-spinner-spin>
Advanced usage
Coming soon
License
Copyright (c) 2019-present, Kenneth Aamås