Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

All notable changes to this package are documented in this file.

## 1.0.0 - 2026-04-01
## 1.1.0 - 2026-04-09

- Initial public package release for `interactive-surface.css`
- Added standalone demo page (`example.html`)
- Added package-local Playwright coverage for:
- state behavior and accessibility media features
- demo rendering and keyboard focus checks
- Added package metadata (`package.json`, exports, scripts, license)
- Standardized color usage to functional notation by converting remaining hex fallbacks in `interactive-surface.css` to `rgb(...)`.
- Added a color-format guard script (`npm run check:no-hex-colors`) to fail builds when hex literals are introduced in `interactive-surface.css`.
- Integrated the color-format guard into `prepublishOnly` so release builds validate RGB/HSL notation before publish.
- Promoted `index.html` as the primary demo/customization app, with `example.html` retained as a backward-compatible export alias.
- Updated docs and wiki guidance for the new color standard, release checklist updates, and demo customization workflow.

## 1.0.2 - 2026-05-01
## 1.0.2 - 2026-04-02

- Added webpack compatibility via a CommonJS entrypoint (`index.cjs`) and `exports.require` mapping.
- Updated package metadata for dual ESM/CommonJS consumption (`main`, `files`, and `sideEffects` updates).
Expand All @@ -20,3 +19,12 @@ All notable changes to this package are documented in this file.
- Added and corrected GitHub templates: issue templates under `.github/ISSUE_TEMPLATE/` and PR template.
- Added and aligned comprehensive wiki pages for API, tokens, accessibility, testing, publishing, FAQ, and roadmap.
- Reworked README structure for clearer usage, publishing, and documentation navigation.

## 1.0.0 - 2026-04-01

- Initial public package release for `interactive-surface.css`
- Added standalone demo page (`example.html`)
- Added package-local Playwright coverage for:
- state behavior and accessibility media features
- demo rendering and keyboard focus checks
- Added package metadata (`package.json`, exports, scripts, license)
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ Webpack:
CDN:

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/interactive-surface-css@1.0.2/interactive-surface.css" />
<link rel="stylesheet" href="https://unpkg.com/interactive-surface-css@1.0.2/interactive-surface.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/interactive-surface-css@latest/interactive-surface.css" />
<link rel="stylesheet" href="https://unpkg.com/interactive-surface-css@latest/interactive-surface.css" />
```

## Quick Start
Expand All @@ -101,7 +101,13 @@ CDN:
</button>
```

Demo page: `example.html`
Demo page: `index.html`

`index.html` is a practical customization playground for this library:

- It provides guided token editing controls instead of freehand CSS typing.
- It supports importing and exporting token CSS so teams can reuse exact values.
- It helps reduce manual entry mistakes when creating app-level theme overrides.

## Class API

Expand Down Expand Up @@ -162,6 +168,7 @@ See [Accessibility](./wiki/Accessibility.md) for implementation guidance.
## Testing

```bash
npm run check:no-hex-colors
npm run lint:css
npm test
npm run test:chromium
Expand All @@ -178,11 +185,11 @@ Release checklist:
2. Bump `version` in `package.json`.
3. Update `CHANGELOG.md`.
4. Push to `main`.
5. Create and publish a GitHub Release tag (for example `v1.0.1`).
5. Create and publish a GitHub Release tag (for example `v1.1.0`).
6. Verify the `Publish to npm` workflow succeeds.
7. Verify CDN availability:
- `https://cdn.jsdelivr.net/npm/interactive-surface-css@1.0.2/interactive-surface.css`
- `https://unpkg.com/interactive-surface-css@1.0.2/interactive-surface.css`
- `https://cdn.jsdelivr.net/npm/interactive-surface-css@<version>/interactive-surface.css`
- `https://unpkg.com/interactive-surface-css@<version>/interactive-surface.css`

Manual fallback:

Expand Down
262 changes: 0 additions & 262 deletions example.html

This file was deleted.

Loading
Loading