Skip to main content
VelinStyle v0.9.0
⌂ Home

Core modules 0.9.0 extension

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

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 (0.9.0)

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.

0.8.0 components

velin-reveal, velin-flip — declarative motion; in 0.9 prefer core/motion and velin-* attributes (see Motion guide).

npm exports

"@birdapi/velinstyle/search": "./core/search/index.js",
"@birdapi/velinstyle/motion": "./core/motion/index.js",
"@birdapi/velinstyle/attributes": "./core/attributes/index.js"

Related: VelinSearch, Motion guide, JavaScript API.