@mart-dev-test-1/solid-adapter
v0.2.2
Published
ECSS Solid adapter — generates SolidJS components from ECSS blocks.
Downloads
210
Maintainers
Readme
import { EButton } from './Button.ecss';
<EButton as="button" params={{ variant: 'primary' }} onClick={onClick}>
Нажми меня
</EButton>;📦 Установка
npm i -D @mart-dev-test-1/solid-adapterpnpm add -D @mart-dev-test-1/solid-adapteryarn add -D @mart-dev-test-1/solid-adapterТребуется установленный solid-js версии 1.8 или выше.
🚀 Подключение
Адаптер регистрируется в ecss.config.ts через defineConfig из @mart-dev-test-1/config — конфиг не привязан к конкретному сборщику, его читает ECSS-плагин вашего бандлера (@mart-dev-test-1/vite-plugin и др.). defaultAdapter указывает, какой адаптер применяется к .ecss-файлам по умолчанию; id Solid-адаптера — 'solid':
// ecss.config.ts
import { defineConfig } from '@mart-dev-test-1/config';
import { solidAdapter } from '@mart-dev-test-1/solid-adapter';
export default defineConfig({
adapters: [solidAdapter()],
defaultAdapter: 'solid',
});🛠 Использование
Каждый @block превращается в компонент SolidJS, который импортируется напрямую из .ecss-файла:
import { EButton } from './Button.ecss';
function App() {
return (
<EButton as="button" params={{ variant: 'primary' }}>
Нажми меня
</EButton>
);
}Имя компонента — это префикс + имя блока: @block Button → EButton, @block Card → ECard.
В отличие от React/Vue-адаптеров, Solid-адаптер module-based: он генерирует настоящие
.jsx-файлы в каталоге.ecss/, потому что JSX компилируется черезvite-plugin-solid(только.jsx/.tsx). Для вас это прозрачно — импортируйте компонент как обычно.
Проп params
Параметры блока передаются единственным пропом params. TypeScript знает их типы из сгенерированного интерфейса {Block}Params (например ButtonParams), поэтому передать несуществующее значение enum не получится.
params обязателен ровно тогда, когда у блока есть хотя бы один обязательный @param (без ?). Если все параметры опциональны или их нет вовсе — проп можно не передавать.
// у Button есть обязательный @param variant → params обязателен
<EButton params={{ variant: 'primary' }} />
// у Card все параметры опциональны → params можно опустить
<ECard />Проп as
По умолчанию компонент рендерится как <div>. Проп as принимает любой HTML-тег и меняет корневой элемент (под капотом — Solid <Dynamic>). Компонент типизирован generic-параметром по выбранному тегу, поэтому набор допустимых HTML-атрибутов сужается автоматически:
<EButton as="button" type="submit" params={{ variant: 'primary' }}>Отправить</EButton>
<EButton as="a" href="/about" params={{ variant: 'ghost' }}>Ссылка</EButton>При as="a" становятся доступны href, target и прочие атрибуты <a>; при as="button" — type, disabled и т.д.
class, style и атрибуты
ECSS задаёт корневому элементу класс блока, CSS-переменные из params и data-атрибуты. То, что передаёт потребитель, объединяется с этими значениями:
class— потребительский класс добавляется к классу блока (Solid используетclass, а неclassName);style— мёрджится поверх CSS-переменных изparams; потребитель может передать как объектJSX.CSSProperties, так и строку CSS — поддерживаются оба варианта;- остальные атрибуты и обработчики (
onClick,aria-*,data-*, …) прокидываются на корневой элемент и выигрывают при коллизии сdata-атрибутами.
Компонент реактивен: блок пересчитывается при изменении params.
🧩 Суб-компоненты (@element)
Если в @block объявлены @element, они становятся вложенными компонентами через статические свойства корневого компонента:
import { EButton } from './Button.ecss';
<EButton params={{ withIcon: true }}>
<EButton.Icon>
<svg>{/* … */}</svg>
</EButton.Icon>
<EButton.Text>Нажми меня</EButton.Text>
</EButton>;Суб-компоненты поддерживают тот же проп as (по умолчанию <div>), но не принимают params.
⚙️ Опции
solidAdapter({
componentNamePrefix: 'E', // по умолчанию 'E'
});| Опция | Тип | По умолчанию | Описание |
| --------------------- | -------- | ------------ | ------------------------------------------------------------------------------ |
| componentNamePrefix | string | 'E' | Префикс имени компонента. Первый символ — [A-Z], остальные — [a-zA-Z0-9_]. |
solidAdapter({ componentNamePrefix: 'My' }); // → MyButton, MyCardНекорректный префикс (не подходящий под /^[A-Z][a-zA-Z0-9_]*$/) приводит к ошибке на этапе сборки.
🔵 Требования
Требуется SolidJS (solid-js) версии 1.8 или выше — адаптер использует splitProps, createMemo и Dynamic.
Сгенерированные компоненты — обычный .jsx (без TypeScript); все типы живут в .ecss.d.ts, поэтому адаптер одинаково работает и в JS-, и в TS-проектах.
👨💻 Автор
Разработка и поддержка: Руслан Мартынов
Если нашёл баг или есть предложение — открывай issue или отправляй pull request.
📄 Лицензия
Распространяется под лицензией MIT.
