Skip to main content
VelinStyle v1.3.0
⌂ Home

Core modules 1.2.2

Tree-shakeable JavaScript modules under core/ — separate from CSS and Web Components in components/. Deutsch: Kernmodule

Maturity: Documented as stable in VelinStyle 1.2.0. Design Intelligence (plan / review / agent meta) is separate and beta / foundation where noted.

When to use

When not

Layout

velinstyle/
  core/
    search/       types.js, engine.js, highlight.js, providers.js, index.js
    motion/       scheduler.js, effects.js, stagger.js, scroll.js, index.js
    attributes/   registry.js, index.js
  components/     velin-search.js, velin-modal.js, …
  cli/            search-index.js, docs-generate.js

core/motion

core/attributes

core/highlight

initHighlight() — lazy language registry, MutationObserver for velin-code / pre code. Subpath: @birdapi/velinstyle/highlight.

core/meta

velin-meta export and velin-agent.json agent bundle — see Velin-Meta guide.

sanitize / email / secure

Package exports: @birdapi/velinstyle/sanitize, ./email, ./secure — used by components and PII tooling.

components/runtime

bootFromDOM() registers only components present in the page. Prefer over full IIFE when bundle size matters.

Legacy motion helpers

velin-reveal / velin-flip / velin-haptic remain as helper modules; prefer core/motion + attributes for new work (Motion guide).

Package exports (1.2.0)

Verified against @birdapi/velinstyle package.json exports:

SubpathRole
@birdapi/velinstyleregister, lazyDefine, bootFromDOM, COMPONENT_LOADERS
@birdapi/velinstyle/runtimeSame runtime API (explicit subpath)
@birdapi/velinstyle/bundleFull minified components bundle
@birdapi/velinstyle/cssMinified CSS
@birdapi/velinstyle/motioninitMotion, stagger, scroll helpers
@birdapi/velinstyle/attributesregisterAttribute, bootAttributes, registry
@birdapi/velinstyle/searchVelinSearch engine
@birdapi/velinstyle/highlightSyntax highlighting
@birdapi/velinstyle/metaAgent meta builders beta
@birdapi/velinstyle/a11yinitA11y
@birdapi/velinstyle/sanitize · /email · /secureSecurity / PII helpers

Related: VelinSearch, Motion guide, JavaScript API.