clasecitas-vlv-types
v1.1.0
Published
Generated TypeScript helpers and class-name types for clasecitas-vlv.
Downloads
277
Maintainers
Readme
clasecitas-vlv-types
Generated TypeScript companion package for clasecitas-vlv.
It ships:
- exact class-name unions generated from the real stylesheet
- runtime arrays and guards for class-name validation
- ambient module declarations for
clasecitas-vlv,clasecitas-vlv/css,clasecitas-vlv/css/min, andclasecitas-vlv/scss
Install
npm install clasecitas-vlv
npm install -D clasecitas-vlv-typesclasecitas-vlv should be a normal dependency because it ships the runtime stylesheet.
clasecitas-vlv-types should be a dev dependency because it only adds TypeScript support.
Register Ambient Modules
Choose one setup path so TypeScript can understand the stylesheet imports from clasecitas-vlv.
Option 1: Side-effect import
import "clasecitas-vlv-types/register";
import "clasecitas-vlv/css";Option 2: tsconfig.json
{
"compilerOptions": {
"types": ["clasecitas-vlv-types/register"]
}
}Use The Generated Types
import type { ClasecitasClassName } from "clasecitas-vlv-types";
import { getInvalidClasecitasClassNames, isClasecitasClassName } from "clasecitas-vlv-types";
const headerClasses: ClasecitasClassName[] = ["flex", "items-center", "gap-4", "md:flex-row"];
isClasecitasClassName("w-1/2");
isClasecitasClassName("text-primary");
getInvalidClasecitasClassNames("flex gap-4 fake-class");Generated Source
This package is generated from the installed clasecitas-vlv dependency during npm run build.
If you need to sync against an unreleased upstream checkout or an exact commit snapshot, point CLASECITAS_VLV_SOURCE_ROOT at a local clasecitas-vlv package root before building:
CLASECITAS_VLV_SOURCE_ROOT=/absolute/path/to/clasecitas-vlv npm run buildThe generated surface follows the real upstream CSS API, including semantic color utilities such as text-primary, bg-success, border-surface, and text-surface. Explicit palette classes such as text-red, bg-blue, border-emerald, and divider-amber are not part of the current generated unions.
Public API
classNamesbaseClassNamesresponsiveClassNamesmoduleSpecifiersbreakpointPrefixessourcePackageNamesourcePackageVersionisClasecitasClassName(value)getInvalidClasecitasClassNames(value)
More detail lives in docs/reference.md.
