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