effcss 3.0.0 → 3.0.2

package/README.md

@@ -15,7 +15,7 @@
 
 </div>
 
-EffCSS is a self-confident CSS-in-JS library based only on the browser APIs.
+EffCSS is a self-confident CSS-in-JS library based only on the browser APIs. Use the full power of JS & TS when creating styles!
 
 ## Some features
 
@@ -25,18 +25,23 @@ EffCSS is a self-confident CSS-in-JS library based only on the browser APIs.
 -   built-in BEM support
 -   server-side rendering compatible
 
-## EffCSS v3
-
-EffCSS v3 is already here! The new version simplifies the API - if you know JS and CSS, you are already know it.
-Docs and examples will be available soon.
-
 ## Links
 
--   [Docs for EffCSS v2](https://effcss.surge.sh)
+-   [Docs](https://effcss.surge.sh)
 -   [Repository](https://gitverse.ru/msabitov/effcss)
 -   [Github mirror](https://github.com/msabitov/effcss)
 
-## EffCSS v2 examples
+## V3 examples
+
+-   [Vanilla TS](https://stackblitz.com/edit/effcss-3-ts-vitejs?file=index.html)
+-   [React](https://stackblitz.com/edit/effcss-3-react-vitejs?file=index.html)
+-   [React SSR](https://stackblitz.com/edit/effcss-3-react-ssr-vitejs?file=index.html)
+-   [Svelte](https://stackblitz.com/edit/effcss-3-svelte-vitejs?file=index.html)
+-   [Svelte SSR](https://stackblitz.com/edit/effcss-3-svelte-ssr-vitejs?file=index.html)
+-   [Vue](https://stackblitz.com/edit/effcss-3-vue-vitejs?file=index.html)
+-   [Vue SSR](https://stackblitz.com/edit/effcss-3-vue-ssr-vitejs?file=index.html)
+
+## V2 examples
 
 -   [React](https://stackblitz.com/edit/vitejs-react-effcss?file=index.html)
 -   [React SSR](https://stackblitz.com/edit/vitejs-react-ssr-effcss?file=index.html)
@@ -49,9 +54,6 @@ Docs and examples will be available soon.
 -   [Lit](https://stackblitz.com/edit/vitejs-lit-effcss?file=index.html)
 -   [Angular](https://stackblitz.com/edit/angular-effcss?file=src%2Findex.html)
 -   [HTML only](https://stackblitz.com/edit/static-effcss?file=index.html)
-
-## Try EffCSS v2 with
-
 -   [Storybook](https://stackblitz.com/edit/storybook-react-effcss?file=src%2Findex.ts)
 -   [Vitest benchmarking](https://stackblitz.com/edit/vitest-bench-effcss?file=tests%2FPublic.bench.ts)
 
@@ -89,20 +91,20 @@ First, define and add `Style provider` to your HTML:
 </html>
 ```
 
-Second, use `Style consumer` to operate styles in your JS:
+Second, use `Style consumer` to operate styles in your code:
 
 **main.js**
 
 ```jsx
-import { createConsumer } from 'effcss/consumer';
+import { createConsumer } from "effcss/consumer";
 
 const consumer = createConsumer();
 
-const root = createRoot(document.getElementById('root'));
+const root = createRoot(document.getElementById("root"));
 root.render(<App css={consumer} />);
 ```
 
-Each CSS stylesheet corresponds to a single `StyleSheet maker`. `Stylesheet maker` is a pure JS function that gets an object with utilities as arguments and should return object with style rules:
+Each CSS stylesheet corresponds to a single `Stylesheet maker`. `Stylesheet maker` is a pure JS function that should return object with style rules:
 
 **App.js**
 
@@ -118,28 +120,32 @@ export interface ICardMaker {
      */
     card: {
         /**
-         * Block modifiers
+         * Card modifiers
          */
         '': {
             /**
-             * Card border radius boolean modifier
+             * Card border radius
              */
             rounded: '';
             /**
-             * Card height modifier
+             * Card height
              */
             h: 'full' | 'half';
         };
         /**
-         * Card footer element
+         * Card logo
+         */
+        logo: {},
+        /**
+         * Card footer
          */
         footer: {
             /**
-             * Footer visibility boolean modifier
+             * Footer visibility
              */
             visible: '';
             /**
-             * Footer size modifier
+             * Footer size
              */
             sz: 's' | 'm' | 'l';
         };
@@ -171,18 +177,12 @@ const myStyleSheetMaker: TStyleSheetMaker = ({ bem, pseudo, at: { kf }, merge })
                 transform: 'rotate(360deg)',
             },
         },
-        '.card-logo': cardLogoStyles,
-        // block
         [bem<ICardMaker>('card')]: { ... },
-        // block boolean attribute
+        [bem<ICardMaker>('card.logo')]: cardLogoStyles,
         [bem<ICardMaker>('card..rounded')]: { ... },
-        // block attribute with value
         [bem<ICardMaker>('card..h.full')]: { ... },
-        // element
         [bem<ICardMaker>('card.footer')]: { ... },
-        // element boolean attribute
         [bem<ICardMaker>('card.footer.visible')]: { ... },
-        // element attribute with value
         [bem<ICardMaker>('card.footer.sz.m')]: { ... },
     };
 };

package/dist/build/define-provider.min.js

@@ -1,5 +1,5 @@
 /*
-* EffCSS v3.0.0
+* EffCSS v3.0.2
 * {@link https://gitverse.ru/msabitov/effcss}
 * Copyright (c) Marat Sabitov
 * @license Apache 2.0

package/dist/consumer.js

@@ -1,5 +1,5 @@
 /*
-* EffCSS v3.0.0
+* EffCSS v3.0.2
 * {@link https://gitverse.ru/msabitov/effcss}
 * Copyright (c) Marat Sabitov
 * @license Apache 2.0

package/dist/index.js

@@ -1,5 +1,5 @@
 /*
-* EffCSS v3.0.0
+* EffCSS v3.0.2
 * {@link https://gitverse.ru/msabitov/effcss}
 * Copyright (c) Marat Sabitov
 * @license Apache 2.0

package/dist/types/src/_provider/_process/base.d.ts

@@ -5,7 +5,7 @@ export declare const getBaseHandlers: () => {
     comma: TJoinArr;
     space: TJoinArr;
     range: (size: number, handler: (k: number) => object) => object;
-    each: <V>(rules: Record<string, V> | V[], handler: (k: string | number, v: V) => object) => object;
+    each: <V extends Record<TStrOrNum, any>>(rules: V, handler: (k: V extends ArrayLike<any> ? string : keyof V, v: V extends ArrayLike<any> ? NoInfer<V[number]> : NoInfer<V[keyof V]>) => object) => object;
     merge: (target: Record<string, any>, ...sources: Record<string, any>[]) => Record<string, any>;
     when: (condition: boolean | undefined, rules: object, otherwise?: object) => object;
 };

package/dist/types/src/_provider/process.d.ts

@@ -86,7 +86,7 @@ export declare const baseHandlers: {
     comma: (...val: (string | number)[]) => string;
     space: (...val: (string | number)[]) => string;
     range: (size: number, handler: (k: number) => object) => object;
-    each: <V>(rules: Record<string, V> | V[], handler: (k: string | number, v: V) => object) => object;
+    each: <V extends Record<string | number, any>>(rules: V, handler: (k: V extends ArrayLike<any> ? string : keyof V, v: V extends ArrayLike<any> ? NoInfer<V[number]> : NoInfer<V[keyof V]>) => object) => object;
     merge: (target: Record<string, any>, ...sources: Record<string, any>[]) => Record<string, any>;
     when: (condition: boolean | undefined, rules: object, otherwise?: object) => object;
 };

package/dist/types/src/common.d.ts

@@ -61,6 +61,7 @@ type TStringBEM<T> = TBlocks<T> | TMods<T> | TElems<T>;
 type TBEM<T> = TDeepPartial<T> | TStringBEM<T> | TStringBEM<T>[];
 type TResolveSelector = <T extends object>(params: TBEM<T>) => string;
 type TResolveAttr = <T extends object>(params: TBEM<T>) => TStrDict;
+type TParts = (string | number)[];
 type TScope = {
     /**
      * BEM selector resolver
@@ -73,15 +74,15 @@ type TScope = {
     /**
      * Name resolver
      */
-    name: (...parts: (string | number)[] | string[]) => string;
+    name: (...parts: TParts) => string;
     /**
      * Var name
      */
-    varName: (...parts: (string | number)[] | string[]) => string;
+    varName: (...parts: TParts) => string;
     /**
      * Var expression
      */
-    varExp: (...parts: (string | number)[]) => string;
+    varExp: (...parts: TParts) => string;
 };
 /**
  * Style scope resolver

package/dist/types/src/index.d.ts

@@ -46,7 +46,7 @@ export interface IStyleProvider {
      */
     set settings(val: Partial<TProviderSettings>);
     /**
-     * Use stylesheet
+     * Use stylesheet maker
      * @param maker - stylesheet maker
      * @returns {@link TResolveAttr | attribute resolver}
      */
@@ -75,7 +75,7 @@ export interface IStyleProvider {
     css(maker: TStyleSheetMaker, key: string): string;
     /**
      * Resolve target key
-     * @param param - style target
+     * @param target - style target
      */
     key(target: TStyleTarget): string | undefined;
     /**
@@ -84,13 +84,13 @@ export interface IStyleProvider {
      */
     status(key: TStyleTarget): boolean;
     /**
-     * Switch stylesheet/stylesheets on
-     * @param target - target stylesheet maker or key
+     * Switch stylesheets on
+     * @param targets - target stylesheet maker or key
      */
     on(...targets: TStyleTarget[]): boolean | undefined;
     /**
-     * Switch stylesheet/stylesheets off
-     * @param target - target stylesheet maker or key
+     * Switch stylesheets off
+     * @param targets - target stylesheet maker or key
      */
     off(...targets: TStyleTarget[]): boolean | undefined;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "effcss",
-    "version": "3.0.0",
+    "version": "3.0.2",
     "description": "Self-confident CSS-in-JS",
     "type": "module",
     "scripts": {