@mart-dev-test-1/svelte-adapter
v0.2.2
Published
ECSS Svelte adapter — generates Svelte 4/5 components from ECSS blocks.
Downloads
202
Maintainers
Readme
<script lang="ts">
import { EButton } from './Button.ecss';
</script>
<EButton as="button" params={{ variant: 'primary' }} onclick={onClick}>
Нажми меня
</EButton>📦 Установка
npm i -D @mart-dev-test-1/svelte-adapterpnpm add -D @mart-dev-test-1/svelte-adapteryarn add -D @mart-dev-test-1/svelte-adapterТребуется установленный svelte версии 4 или выше.
🚀 Подключение
Адаптер регистрируется в ecss.config.ts через defineConfig из @mart-dev-test-1/config — конфиг не привязан к конкретному сборщику, его читает ECSS-плагин вашего бандлера (@mart-dev-test-1/vite-plugin и др.). defaultAdapter указывает, какой адаптер применяется к .ecss-файлам по умолчанию; id Svelte-адаптера — 'svelte':
// ecss.config.ts
import { defineConfig } from '@mart-dev-test-1/config';
import { svelteAdapter } from '@mart-dev-test-1/svelte-adapter';
export default defineConfig({
adapters: [svelteAdapter()],
defaultAdapter: 'svelte',
});🛠 Использование
Каждый @block превращается в компонент Svelte, который импортируется напрямую из .ecss-файла:
<script lang="ts">
import { EButton } from './Button.ecss';
</script>
<EButton as="button" params={{ variant: 'primary' }}>
Нажми меня
</EButton>Имя компонента — это префикс + имя блока: @block Button → EButton, @block Card → ECard. Содержимое передаётся через слот по умолчанию (всё, что между тегами).
В отличие от React/Vue-адаптеров, Svelte-адаптер module-based: он генерирует настоящие
.svelte-файлы в каталоге.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-тег и меняет корневой элемент. В Svelte 5 тип сужается по выбранному тегу (через generics + SvelteHTMLElements), поэтому доступны соответствующие атрибуты:
<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— потребительский класс добавляется к классу блока, не затирая его;style— добавляется к CSS-переменным, сгенерированным изparams;- остальные атрибуты и обработчики (
id,aria-*,onclick,href, …) прокидываются на корневой элемент и выигрывают при коллизии сdata-атрибутами.
🧩 Суб-компоненты (@element)
Если в @block объявлены @element, они становятся вложенными компонентами через статические свойства корневого компонента и доступны в шаблоне через точечную нотацию:
<EButton params={{ withIcon: true }}>
<EButton.Icon>
<svg><!-- … --></svg>
</EButton.Icon>
<EButton.Text>Нажми меня</EButton.Text>
</EButton>Суб-компоненты поддерживают тот же проп as (по умолчанию <div>), но не принимают params.
⚙️ Опции
svelteAdapter({
componentNamePrefix: 'E', // по умолчанию 'E'
});| Опция | Тип | По умолчанию | Описание |
| --------------------- | -------- | ------------ | ------------------------------------------------------------------------------ |
| componentNamePrefix | string | 'E' | Префикс имени компонента. Первый символ — [A-Z], остальные — [a-zA-Z0-9_]. |
svelteAdapter({ componentNamePrefix: 'My' }); // → MyButton, MyCardНекорректный префикс (не подходящий под /^[A-Z][a-zA-Z0-9_]*$/) приводит к ошибке на этапе сборки.
🟠 Поддержка версий Svelte
Адаптер определяет мажорную версию Svelte, установленного в проекте, и генерирует соответствующий код:
- Svelte 5 — компоненты на рунах (
$props,$derived), слот через{@render children?.()}; события — обычные атрибуты (onclick,oninput, …). - Svelte 4 —
export let+ реактивные объявления$:, слот через<slot />; все события (on:click,on:input, …) автоматически перенаправляются на корневой элемент.
Версия читается из svelte/package.json относительно корня проекта и кешируется. Если Svelte не удаётся разрешить, адаптер выводит предупреждение и использует Svelte 5 как значение по умолчанию.
👨💻 Автор
Разработка и поддержка: Руслан Мартынов
Если нашёл баг или есть предложение — открывай issue или отправляй pull request.
📄 Лицензия
Распространяется под лицензией MIT.
