@chassis-ui/website-icons 0.0.0 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+The notable changes of each release of `@chassis-ui/website-icons`, in the form of
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Written by hand, in the commit that
+sets the version. The body of the GitHub release is the entry of its version, and a version
+without an entry is not released. An entry names the icons that are added, renamed or removed.
+
+The history of the set before 0.1.0 is in the
+[changelog of Chassis Icons](https://github.com/chassis-ui/icons/blob/main/packages/icons/CHANGELOG.md),
+up to `@chassis-ui/icons` 0.4.0-next.0.
+
+## [0.1.0]
+
+### Added
+
+- The icons of the Chassis website, moved from `@chassis-ui/icons`, with the 501 icons
+  and the code points of its 0.4.0-next.0: the font `chassis-icons` with the class prefix
+  `cx-`, in the styles `outline`, `solid` and `brand`. A project that installed
+  `@chassis-ui/icons` for the set installs `@chassis-ui/website-icons`, and no icon changes
+  its name or its code point. The files are in `dist/`: `icons/chassis-icons.*` is
+  `dist/web/chassis-icons.*`, and `svgs/<name>.svg` is `dist/svgs/<name>.svg`.
+- `dist/icons.json`, the index of the set: the font name, the class prefix, the frame, the
+  styles and the pairs, and each icon with its code point, its style and its name without
+  the style.
+- The page of the set, which `pnpm preview` writes into `preview/` and serves, and which the
+  archive of a release holds.
+- The icons for apps, in the archives of each release beside
+  `chassis-icons-web-<version>.zip`. `chassis-icons-ios-<version>.zip`: the asset catalog
+  `ChassisIcons.xcassets`, a template vector image per icon, and `ChassisIcons.swift`, the enum
+  `CxIcon` with `Image(CxIcon.<name>)` and `UIImage(CxIcon.<name>)`.
+  `chassis-icons-android-<version>.zip`: a vector drawable per icon, `R.drawable.cx_<name>`.
+  The npm package holds the files for the web only.
+- Built with `@chassis-ui/icons` 0.4.0, which is the builder of icon sets from this version on.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chassis UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,96 @@
 # @chassis-ui/website-icons
 
-A placeholder. The icons of the Chassis website are published from
-[chassis-ui/website-icons](https://github.com/chassis-ui/website-icons), from 0.1.0 on.
+The icons of the Chassis website, in outline, solid and brand styles, as an icon font, an SVG sprite, optimized SVG files and files for iOS and Android, built with @chassis-ui/icons
+
+The set has 501 icons. Each is drawn on a frame of 24 by 24 in one color, and takes the color of the text around it.
+
+```bash
+npm install @chassis-ui/website-icons
+```
+
+## What the package holds
+
+- `dist/svgs/<name>.svg`: one optimized file per icon
+- `dist/web/chassis-icons.css` and `dist/web/chassis-icons.min.css`: the stylesheet of the icon font, with one class per icon
+- `dist/web/chassis-icons.scss`: the same stylesheet for Sass, with the folder of the font and the map of the icons as variables
+- `dist/web/chassis-icons.woff2`, `dist/web/chassis-icons.woff`: the icon font, which the stylesheets load from their own folder
+- `dist/web/chassis-icons.svg`: the SVG sprite, one `<symbol>` per icon with the name of the icon as its `id`
+- `dist/web/chassis-icons.json`: the code point of each icon in the font, by name
+- `dist/icons.json`: the index of the set: its font name, class prefix, frame and styles, and each icon with its code point and its style
+
+The files for iOS and Android are not in the package: they are in the archives of the releases.
+
+The last part of a name is the style of the icon: `<name>-outline`, `<name>-solid` or `<name>-brand`. The examples below show `alarm-clock-outline`.
+
+## Use
+
+### The icon font
+
+One class per icon, `cx-<name>`, on an empty element:
+
+```html
+<link rel="stylesheet" href="node_modules/@chassis-ui/website-icons/dist/web/chassis-icons.min.css" />
+
+<i class="cx-alarm-clock-outline"></i>
+```
+
+With a bundler, `import '@chassis-ui/website-icons'` loads the same stylesheet and its font.
+
+### The SVG sprite
+
+One file for the whole set, and one `<use>` per icon:
+
+```html
+<svg width="24" height="24" fill="currentcolor" aria-hidden="true">
+  <use href="node_modules/@chassis-ui/website-icons/dist/web/chassis-icons.svg#alarm-clock-outline"></use>
+</svg>
+```
+
+### A single SVG file
+
+```html
+<img src="node_modules/@chassis-ui/website-icons/dist/svgs/alarm-clock-outline.svg" alt="" width="24" height="24" />
+```
+
+### Sass
+
+The classes of the stylesheet, with the font served from a folder of your own, and the map of the icons for a selector of your own:
+
+```scss
+@use 'sass:map';
+@use '@chassis-ui/website-icons/dist/web/chassis-icons.scss' as icons with (
+  $chassis-icons-font-dir: '/fonts'
+);
+
+.my-icon::before {
+  font-family: icons.$chassis-icons-font;
+  content: map.get(icons.$chassis-icons-map, 'alarm-clock-outline');
+}
+```
+
+Sass finds the file in a load path that holds `node_modules`, and so does a bundler. With the package importer of Sass, `@use 'pkg:@chassis-ui/website-icons'` loads the same file.
+
+### iOS
+
+Add `ChassisIcons.xcassets` and `ChassisIcons.swift` to the target of an app, from the archive `chassis-icons-ios-<version>.zip` of a release of [the repository](https://github.com/chassis-ui/website-icons). Each icon is a case of `CxIcon`, and draws as a template image in the tint of its view:
+
+```swift
+Image(CxIcon.alarmClockOutline)
+UIImage(CxIcon.alarmClockOutline)
+```
+
+### Android
+
+Copy `res/` from the archive `chassis-icons-android-<version>.zip` of a release of [the repository](https://github.com/chassis-ui/website-icons) into `src/main/` of a module. Each icon is a drawable that takes the tint of its view:
+
+```kotlin
+Icon(painterResource(R.drawable.cx_alarm_clock_outline), contentDescription = null)
+```
+
+## The source
+
+The package is built from the SVG files of its [repository](https://github.com/chassis-ui/website-icons) with [`@chassis-ui/icons`](https://www.npmjs.com/package/@chassis-ui/icons). An icon is added or changed there, and never in the files of `dist/`. `pnpm build` writes the output into `dist/`, which is not committed, `pnpm lint` checks the files of the source, and `pnpm verify` checks that the source builds, that the registry of the code points and this README are up to date, and that no icon lost its code point. `pnpm preview` writes the page of the set into `preview/` and serves it, to browse the icons, their classes, their code points and the code that draws them.
+
+## License
+
+MIT