chiri
v1.0.1
Published
A stylesheet language named after yours truly, focused on reusable mixins for styling components.
Downloads
7
Readme
chiri
A stylesheet language named after yours truly, focused on reusable mixins for styling components.
Example
npm install chiri
chiri index.chiri
; index.chiri
; define mixins (they can be single-line or multi-line)
%borderless:
border: none
%border-1: border: 1px solid
%border-2: border: 2px solid
%text-purple: colour: rebeccapurple
%text-blue:
colour: blue
; apply them to components
.button-main:
%borderless
%text-purple
.button-secondary:
%border-2
%text-blue
The output of the above code is the following, but the js and css files are minified:
/* index.css */
.borderless { border: none }
/* border-1 was never used, so it's skipped */
.border-2 { border: 2px solid }
.text-purple { color: rebeccapurple }
.text-blue { color: blue }
// index.js
const ChiriClasses = {
"button-main": ["borderless", "text-purple"],
"button-secondary": ["border-2", "text-blue"]
};
export default ChiriClasses;
// index.d.ts
declare const ChiriClasses: {
"button-main": string[];
"button-secondary": string[];
};
export default ChiriClasses;
export as namespace ChiriClasses;
Generated Class Ordering
If mixins are compiled into CSS classes, you might be wondering whether you have to constantly keep the declaration order of your mixins in mind so that components appear how you'd like them to appear. The answer is no — mixin classes are generated dynamically based on what the components need.
If a previously generated class for a mixin is generated before a mixin you want to take higher precedence on a component, a new copy of the mixin class is generated. This is handled smartly based on the contents of the mixins — if two mixins contain no intersecting properties, then no new mixin class needs to be generated.
Many properties in CSS are shorthands for other properties, or can affect other properties — in these cases, you can tell chirilang about them via #shorthand property-name:
— every property name specified in the body of the shorthand is considered affected by property-name
, which means intersections can be detected. The default lib has some shorthands already set up, but do not trust that they are anywhere near exhaustive.
Selectors
Selectors are more restrictive than in base CSS, as chiri stylesheets are intended to be used exclusively for components, and anything that needs custom styles should be a component.
Anatomy of a selector:
class name|state (optional) -|- .button-main|:hover
That's it.
Possible values for state
are as follows:
; state selectors that match the component itself:
:hover ; equivalent to CSS :hover:not(:has(:hover))
:active ; equivalent to CSS :active:not(:has(:active))
:focus ; equivalent to CSS :focus-visible
:focus-any ; equivalent to CSS :focus
; state selectors that also match descendants:
::hover ; equivalent to CSS :hover
::active ; equivalent to CSS :active
::focus ; equivalent to CSS :has(:focus-visible)
::focus-any ; equivalent to CSS :focus-within
Other Stuff
chiri supports many other language constructs — variables, macros, if/else, loops, functions, importing other files, etc. It also supports interpolation, allowing you to inject variable contents into strings or property names and values. At time of writing I don't have time to document all of this, but if you want examples, check out the default lib.