Upgrading VelinStyle 1.2.2
Current target is 1.2.2. Follow semver and the CHANGELOG when bumping velinstyle in package.json or your CDN pin. Deutsch: Aktualisieren
When to upgrade
- From 1.1.0 — adopt overlay lifecycle fixes and optional DI commands without class renames.
- From <1.2 — pin
@1.2.2, skim 1.2.2 and 1.2.1 foundations, then older sections as needed.
When not
- Migrating from Tailwind/Bootstrap is a different path — use the Migration Guide.
- Do not treat beta plan/review as required for a CSS-only upgrade.
Semver
Patch — bug fixes, safe to upgrade. Minor — new utilities or components, backward compatible. Major — breaking class or token renames; use the migration notes in GitHub releases.
Checklist
- Read the release notes on GitHub Releases
- Update npm:
npm install @birdapi/velinstyle@latestor pin a version - Re-run visual tests and
npx velinstyle scanon templates - Compare token changes in CSS Variables
Legacy notes (0.7.0)
0.7.0 added WCAG-oriented CSS modules (focus-not-obscured, target size, optional enhanced contrast).
- New CSS:
focus-not-obscured.css,target-size.css,high-contrast-aaa.css;security.cssis now a separate@layer security. - Web Components: improved keyboard/ARIA for collapse, popover, tooltip, carousel, dropdown, drawer, accordion; modal/drawer use
inerton background. - CLI: four new
a11y/*scanner rules; framework addsnpm run test:contrast.
WCAG 2.2 AAA (0.9+)
- Tokens: AAA contrast is now the default in
:root, dark, and 13 themes — usedata-velin-contrast="aa"only if you need lighter muted text. - Components: 43 Web Components in
core/a11y/component-contracts.json(all pass); runnpm run test:a11y:coveragein the framework repo. - Runtime:
import { initA11y } from '@birdapi/velinstyle/a11y'— announcer + scroll padding for fixed nav. - Dialogs: empty
<velin-dialog>/<velin-modal>needaria-labelor a titled header. - Docs: AAA matrix · Accessibility
Upgrading within 0.9.x
- Runtime: default export
@birdapi/velinstyle— useregister()+bootFromDOM()instead of loading the full IIFE when possible. - Component tags: prefer
velin-tooltipandvelin-stepper;velin-tooltip-wc/velin-stepper-wcare deprecated aliases (source files renamed). - Spacing:
.velin-mb-*is margin-bottom; use.velin-my-*for block-axis spacing. - Security:
sanitizeSearchUrl, DOMPurify for SVG — see Security. - WCAG: targets WCAG 2.2 Level AAA token defaults and component contracts — your app certification remains your responsibility — matrix.
Upgrading within 1.0.x
- Runtime: default export
@birdapi/velinstyle— useregister()+bootFromDOM()instead of loading the full IIFE when possible. - Aliases:
velin-tooltip-wcandvelin-stepper-wcare deprecated aliases — usevelin-tooltip/velin-stepper(source files renamed). - Spacing:
.velin-mb-*is margin-bottom; use.velin-my-*for block-axis spacing. - Security:
sanitizeSearchUrl, DOMPurify for SVG — see Security. - WCAG: targets WCAG 2.2 Level AAA token defaults — AAA matrix.
Upgrading to 1.3.0
Patch release focused on the Production Builder and Showcase P0 primitives. CSS/WC APIs remain compatible.
- Publish path:
velinstyle production . --explain→ linkdist/velin-production/instead of the full CDN bundle. See Production Builder. - New WCs:
<velin-otp-input>,<velin-password-strength>,<velin-empty-state>. - Overlays: reactive
title+slot="title"on modal / drawer / sheet. - Tables: row severity via
velin-data-table__row--*,data-severity, and.velin-table--*aliases. - Pin
@birdapi/velinstyle@1.3.0. Package guide: UPGRADING.md.
Upgrading within 1.1 → 1.2.0 foundations
A minor release: no classes, tokens, or tags were removed, so an existing 1.0.x integration keeps working after the version bump. The deprecated velin-tooltip-wc and velin-stepper-wc aliases are still shipped.
- New components:
<velin-data-table>and<velin-form-summary>. Both enhance existing markup, so nothing changes until you wrap a<table>or a<form>. - Form summary takes over validation: unless you set
native-validation, the element setsnoValidateon its form and replaces the browser bubbles with a focusable summary. Remove your own submit-time validation handler for that form. - React adapter:
@velinstyle/reactis now official and covers every canonical component. If you wrote your own wrappers, replace them — see Vite & React. - Highlighting: Python, YAML, Go and Rust lexers load lazily like the existing languages; no change needed to
<velin-code-block>usage. - Release guard:
npm run release:checkin the framework repo verifies that versions and component counts match across framework and site. Add it to your own CI if you fork the docs.
Upgrading to 1.3.0
A minor foundation release: CSS, Web Components, and runtime remain stable. New Design Intelligence surfaces ship as beta / foundation — usable now, schemas and heuristics still expanding. Studio and the complete Utility Engine stay planned.
- Plan-first pages:
velinstyle plan/scaffolduse the page/section registry before HTML. Fragment recipes (navbar, modal, …) are unchanged. See Prompt scaffolding. - Review gate (beta):
velinstyle reviewscores design / a11y / SEO / performance / conversion heuristically — not perceptual QA. - Agent metadata (beta):
velin-agent.jsonembeds knowledge graph, pages, sections, and design constraints. See Velin-Meta. - Overlay lifecycle: modal / drawer / sheet / lightbox use only
focus-managerfor inert + scroll lock;velin-dialogdispatches canonicalvelin-close. - No breaking class renames in this minor — pin
@birdapi/velinstyle@1.3.0when ready.
Changelog
The canonical changelog lives in the CHANGELOG.md file in the framework repository.
Migrating from Tailwind or Bootstrap? See the Migration Guide (different from version upgrades).