Plumeria logoPlumeria
API reference

zss-engine

It is the plumeria Runtime zss-engine package
You can use this to develop Zero-runtime StyleSheet CSS-in-JS libraries.

Installation

Terminal
npm i zss-engine

Overview

TypeScript
export type { CSSProperties } from './types/common/css-properties';
export type { CreateStyleType, ReturnType, CreateStyle } from './types/main/create';
export type { CSSHTML, CreateKeyframes } from './types/main/global';
export type { CreateValues, CreateTheme, ReturnVariableType, RxVariableSet, ReturnRx } from './types/main/vars';
export { isServer, isDevelopment, isTestingDevelopment } from './utils/helper.js';
export { genBase36Hash } from './utils/hash.js';
export { transpile } from './utils/transpile.js';
export { transpileAtomic } from './utils/transpile-atomic.js';
export { splitAtomicAndNested, processAtomicProps } from './utils/processor-atomic.js';
export { build } from './utils/build.js';
export { camelToKebabCase, applyCssValue } from './utils/helper.js';
export { injectClientCSS } from './utils/inject-client-css.js';
export { injectClientGlobalCSS } from './utils/inject-client-global-css.js';

API

Helpers

For branching the environment.

TypeScript
const isWindowDefined = typeof window !== 'undefined';
const isDocumentDefined = typeof document !== 'undefined';
export const isServer = !isWindowDefined || !isDocumentDefined;
export const isDevelopment = process.env.NODE_ENV === 'development';
export const isDevAndTest = process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test';

Functions

genBase36Hash

Arguments: object, number of hash lengths
Returns: string of hash

TypeScript
  const base36Hash = genBase36Hash(object, 6); 

transpiler

Argments: object: style object, hash: string
Returns: styleSheet: string

TypeScript
  const { styleSheet } = transpiler(object, base36Hash);

transpilerAtomic

Argments: object: style object, value: string | number, hash: string
Returns: styleSheet: string

TypeScript
  const { styleSheet } = transpilerAtomic(object, property, atomichash);

build

Argments: styleSheet: string, filePath: string
Returns: void

TypeScript
  build(styleSheet, filePath);

injectClientCSS

Argments: hash: string, styleSheet: string
Returns: void

TypeScript
  injectClientCSS(base36Hash, styleSheet);

injectClientGlobalCSS

Argments: styleSheet: string, scoped: string
Returns: void

TypeScript
  injectClientGlobalCSS(styleSheet, 'global');

Types

For API development.

TypeScript
// create method
CSSProperties, // supply
CreateStyle, // supply
CreateStyleType<T>, 
ReturnType<T>,
 
// global method
CSSHTMLType, // supply
 
// keyframes method
CreateKeyframes,
 
// defineConsts and defineVars method
CreateValues,
 
// defineTheme method
CreateTheme,

On this page