Skip to content

Latest commit

 

History

History

shiraha

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Shiraha

Material 3-inspired Classless CSS Framework.

Usage

NPM

Install this package:

pnpm add -D shiraha # pnpm
# yarn add -D shiraha # yarn
# npm i -D shiraha # npm

CDN

Stable

You can get the shiraha package from your favorite CDN.

For example, unpkg and jsdelivr:

<!-- unpkg -->
<link rel="stylesheet" href="https://unpkg.com/shiraha" />
<!-- equal <link rel="stylesheet" href="https://unpkg.com/shiraha/dist/shiraha.css" /> -->

<!-- jsdelivr -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/shiraha" />
<!-- equal <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/shiraha/dist/shiraha.css" /> -->

Nightly

You can get the nightly build from shiraha.js.org/nightly, This path provides only the dist.

Please note that everything should be considered unstable.

<!-- shiraha.js.org/nightly -->
<link rel="stylesheet" href="https://shiraha.js.org/nightly/shiraha.css" />

Import

Base

The base style of Shiraha, not including themes.

import 'shiraha'

// or
// import 'shiraha/dist/shiraha.css'

// source (sugarss)
// import 'shiraha/src/shiraha.sss'

Themes

You may want to use your own theme or generate a theme through Shiraha Colors / Material Color Utilities, so Shiraha does not come with a theme.

If you only need some preset themes, simply import them manually:

// baseline theme
import 'shiraha/dist/themes/baseline.css'
// source (sugarss)
// import 'shiraha/src/themes/baseline.sss'

// yuki theme
import 'shiraha/dist/themes/yuki.css'
// source (sugarss)
// import 'shiraha/src/themes/yuki.sss'

Addons

Shiraha base styles are classless whenever possible, while some that require class names or are not suitable to be enabled by default will become addons.

For a detailed description of each addon, please see shiraha.js.org.

import 'shiraha/dist/addons/chips.css'

// source (sugarss)
// import 'shiraha/src/addons/chips.sss'