Quick Start

1. Requirements

Before proceeding, you need to have the latest stable node.js
Recommended environment:
  • node js 20+
  • npm js 10+

2. Installation

Open package folder and install its dependencies. We recommended yarn or npm.
Script Project Folder
Install npm
 
                          
cd project-folder
npm install
Start
 
                          
npm run dev
Build
 
                          
npm run build or yarn build

3. Color Themes

By default, Spike applies the default theme using the actTheme attribute to define the skin option. You can modify it or add your custom skin as needed in config.ts file.

By Default we are giving 6 color themes :

BLUE_THEME AQUA_THEME PURPLE_THEME GREEN_THEME CYAN_THEME ORANGE_THEME 
                
actTheme: 'BLUE_THEME',

4. Theming

Spike offers both light and dark style options, with the light style set as the default.

By Default we are giving 6 color themes for each, you just need to change attribute of data-bs-theme :

BLUE_THEME with Light Theme AQUA_THEME with Light Theme PURPLE_THEME with Light Theme GREEN_THEME with Light Theme CYAN_THEME with Light Theme ORANGE_THEME with Light Theme DARK_BLUE_THEME with Dark Theme DARK_AQUA_THEME with Dark Theme DARK_PURPLE_THEME with Dark Theme DARK_GREEN_THEME with Dark Theme DARK_CYAN_THEME with Dark Theme DARK_ORANGE_THEME with Dark Theme 
                
actTheme: 'DARK_BLUE_THEME', // Change is here

5. RTL Supported

Spike comes with built-in RTL support by default.

To enable RTL direction, add setRTLLayout: true attribute in config.ts file.

ltr rtl 
                
setRTLLayout: true,