Upgrading VelinStyle
Follow semver and the CHANGELOG when bumping velinstyle in package.json or your CDN pin.
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
Upgrading to 1.0.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+, Unreleased)
- 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: 36 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.
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).