Skip to content

sauron0914/verification-code

Repository files navigation

@suolun/verification-code

NPM Version Download Month gzip with dependencies: kb typescript pkg.module

pkg.module supported, which means that you can apply tree-shaking in you project

中文文档

A description for the module

repository

Demo

Run Example

Your can see the usage by run the example of the module, here is the step:

  1. Clone the library git clone
  2. Go to the directory cd your-module-directory
  3. Install npm dependencies npm i(use taobao registry: npm i --registry=http://registry.npm.taobao.org)
  4. Open service npm run dev
  5. See the example(usually is http://127.0.0.1/examples/test.html) in your browser

Installation

npm i -S @suolun/verification-code

Global name - The variable the module exported in umd bundle

VerificationCode

Interface

See what method or params you can use in index.d.ts

Usage

import * as VerificationCode from '@suolun/verification-code'

Use in html, see what your can use in CDN: unpkg

<-- use what you want -->
<script src="https://unpkg.com/@suolun/verification-code/lib/umd/<--module-->.js"></script>

style

For building style, you may need to import the css or scss file:

// scss
import '@suolun/verification-code/lib/css/index.scss'

// css
import '@suolun/verification-code/lib/css/index.css'

Or

// scss
@import '@suolun/verification-code/lib/css/index.scss'

// css
@import '@suolun/verification-code/lib/css/index.css'

Or, you can build your custom style by copying, editing and importing @suolun/verification-code/lib/css/index.scss

QA

  1. Error Error: spawn node-sass ENOENT

You may need install node-sass globally, npm i -g node-sass

About

verification-code

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published