@bymax-one/icons 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -1
- package/README.md +36 -41
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -13,6 +13,20 @@ The date of a section is the day the release was prepared, not the day the versi
|
|
|
13
13
|
|
|
14
14
|
## [Unreleased]
|
|
15
15
|
|
|
16
|
+
## [1.0.2] - 2026-11-21
|
|
17
|
+
|
|
18
|
+
A documentation patch: the code, the icons and the types in `dist/` are the same as 1.0.0. It carries the changes that 1.0.1 was tagged for.
|
|
19
|
+
|
|
20
|
+
### Changed
|
|
21
|
+
|
|
22
|
+
- The README states the package as published. The status note and the "ships in 1.0.0" marker are gone, the counts are plain facts in the overview, the subpath table has no status column, and install and the peer matrix live in Quick Start only.
|
|
23
|
+
- The README points at the catalog (`https://bymaxone.github.io/icons/`) and carries a mutation badge that links to the CI workflow. The package's `homepage` is the catalog too, so the npm page links to it.
|
|
24
|
+
- The release is published by the `release.yml` workflow from a `v1.0.2` tag, with npm provenance and the trusted publisher; 1.0.0 was published by hand.
|
|
25
|
+
|
|
26
|
+
## [1.0.1] - 2026-11-20
|
|
27
|
+
|
|
28
|
+
Tagged but never published: the release workflow reached its time limit before the publish. Its changes ship in 1.0.2.
|
|
29
|
+
|
|
16
30
|
## [1.0.0] - 2026-11-19
|
|
17
31
|
|
|
18
32
|
The first published version: 1,298 line icons, 51 filled variants, 45 hand-tuned 16 px masters,
|
|
@@ -279,5 +293,7 @@ an SVG sprite and typed metadata.
|
|
|
279
293
|
`pnpm family-sheet` renders the whole set by category; and a pull request that changes a
|
|
280
294
|
drawing gets a preview comment with its render and its nearest matches.
|
|
281
295
|
|
|
282
|
-
[Unreleased]: https://github.com/bymaxone/icons/compare/v1.0.
|
|
296
|
+
[Unreleased]: https://github.com/bymaxone/icons/compare/v1.0.2...HEAD
|
|
297
|
+
[1.0.2]: https://github.com/bymaxone/icons/compare/v1.0.0...v1.0.2
|
|
298
|
+
[1.0.1]: https://github.com/bymaxone/icons/compare/v1.0.0...v1.0.1
|
|
283
299
|
[1.0.0]: https://github.com/bymaxone/icons/releases/tag/v1.0.0
|
package/README.md
CHANGED
|
@@ -9,13 +9,14 @@
|
|
|
9
9
|
<sub>24 px grid · 1.5 px round stroke · React 19 and Server Components · Raw SVG and sprite · Typed metadata · Zero Runtime Dependencies</sub>
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
|
-
<p align="center"><a href="https://
|
|
12
|
+
<p align="center"><a href="https://bymaxone.github.io/icons/">Browse every icon in the catalog</a></p>
|
|
13
13
|
|
|
14
14
|
<p align="center">
|
|
15
15
|
<a href="https://www.npmjs.com/package/@bymax-one/icons"><img src="https://img.shields.io/npm/v/@bymax-one/icons?style=flat-square&colorA=000000&colorB=000000" alt="npm version" /></a>
|
|
16
16
|
<a href="https://www.npmjs.com/package/@bymax-one/icons"><img src="https://img.shields.io/npm/dm/@bymax-one/icons?style=flat-square&colorA=000000&colorB=000000" alt="npm downloads" /></a>
|
|
17
17
|
<a href="https://github.com/bymaxone/icons/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/bymaxone/icons/ci.yml?branch=main&style=flat-square&colorA=000000&label=CI" alt="CI status" /></a>
|
|
18
18
|
<a href="https://github.com/bymaxone/icons/actions/workflows/ci.yml"><img src="https://img.shields.io/badge/coverage-100%25-brightgreen?style=flat-square&colorA=000000" alt="coverage" /></a>
|
|
19
|
+
<a href="https://github.com/bymaxone/icons/actions/workflows/ci.yml"><img src="https://img.shields.io/badge/mutation-100%25-brightgreen?style=flat-square&colorA=000000" alt="mutation score" /></a>
|
|
19
20
|
<a href="https://scorecard.dev/viewer/?uri=github.com/bymaxone/icons"><img src="https://api.scorecard.dev/projects/github.com/bymaxone/icons/badge?style=flat-square" alt="OpenSSF Scorecard" /></a>
|
|
20
21
|
<a href="https://github.com/bymaxone/icons/blob/main/LICENSE"><img src="https://img.shields.io/github/license/bymaxone/icons?style=flat-square&colorA=000000&colorB=000000" alt="license" /></a>
|
|
21
22
|
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript" /></a>
|
|
@@ -40,12 +41,10 @@ Every non-brand glyph is an original Bymax drawing built on one grid and one set
|
|
|
40
41
|
so the products that use it do not look like every other app built on the same open-source
|
|
41
42
|
set.
|
|
42
43
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
> sprite symbol, because the sprite holds `currentColor` drawings. Every drawing is also a
|
|
48
|
-
> React Native component, from `./native`.
|
|
44
|
+
The package holds 1,298 line icons, 51 filled variants, 45 hand-tuned 16 px masters, 110
|
|
45
|
+
brand marks and 250 country flags, each as a component, a raw SVG file and a metadata entry;
|
|
46
|
+
every drawing except a flag is also a sprite symbol, because the sprite holds `currentColor`
|
|
47
|
+
drawings. Every drawing is also a React Native component, from `./native`.
|
|
49
48
|
|
|
50
49
|
The library has **zero direct dependencies**: `react` arrives as a peer dependency, so you
|
|
51
50
|
control its version and the supply-chain surface stays minimal.
|
|
@@ -67,13 +66,11 @@ control its version and the supply-chain surface stays minimal.
|
|
|
67
66
|
|
|
68
67
|
## 🔥 Features
|
|
69
68
|
|
|
70
|
-
✅ marks what the package ships in 1.0.0.
|
|
71
|
-
|
|
72
69
|
### 🎨 Drawing System
|
|
73
70
|
|
|
74
71
|
- ✅ **The grid as data**: `ICON_GRID` holds the viewBox, live area, padding and stroke of the
|
|
75
72
|
24 px master, frozen and typed with literal values
|
|
76
|
-
- ✅ **The design language
|
|
73
|
+
- ✅ **The design language**: the twelve keystone icons (`home`, `search`, `play`,
|
|
77
74
|
`plus`, `close`, `check`, `settings`, `user`, `file`, `folder`, `lightning`, `scene`) fix
|
|
78
75
|
the signature of the set, a 1.5 px cut that keeps distinct parts from touching
|
|
79
76
|
- ✅ **The line set**: icons in the same language, from navigation and actions to media,
|
|
@@ -120,23 +117,23 @@ control its version and the supply-chain surface stays minimal.
|
|
|
120
117
|
|
|
121
118
|
## 📦 Subpath Exports
|
|
122
119
|
|
|
123
|
-
| Subpath | Contents |
|
|
124
|
-
| ----------------------- | ---------------------------------------------------------------------------- |
|
|
125
|
-
| `.` | Every line, filled and 16 px component, the `Icon` base and the types |
|
|
126
|
-
| `./runtime` | The `Icon` base, `createIcon` and their types |
|
|
127
|
-
| `./meta` | Typed metadata and the `IconName` union, with no React import |
|
|
128
|
-
| `./icons/<name>` | One icon's components, for consumers that avoid barrels |
|
|
129
|
-
| `./brands` | Brand components |
|
|
130
|
-
| `./flags` | Country flag components (`BrFlagIcon`), 16 px high by default |
|
|
131
|
-
| `./flags/<name>` | One flag's component, for a dynamic import |
|
|
132
|
-
| `./native` | Every line, filled and 16 px icon as a React Native component, and the bases |
|
|
133
|
-
| `./native/icons/<name>` | One icon's React Native components, for a dynamic import |
|
|
134
|
-
| `./native/brands` | Brand components for React Native |
|
|
135
|
-
| `./native/flags` | Flag components for React Native |
|
|
136
|
-
| `./native/runtime` | The native base, `createNativeIcon` and their types |
|
|
137
|
-
| `./svg/*` | Raw SVG files (`svg/line/<name>.svg`, `filled`, `sm`, `brands`, `flags`) |
|
|
138
|
-
| `./sprite.svg` | The SVG sprite, one `<symbol>` per drawing |
|
|
139
|
-
| `./metadata.json` | Merged metadata of every icon, brand and flag |
|
|
120
|
+
| Subpath | Contents |
|
|
121
|
+
| ----------------------- | ---------------------------------------------------------------------------- |
|
|
122
|
+
| `.` | Every line, filled and 16 px component, the `Icon` base and the types |
|
|
123
|
+
| `./runtime` | The `Icon` base, `createIcon` and their types |
|
|
124
|
+
| `./meta` | Typed metadata and the `IconName` union, with no React import |
|
|
125
|
+
| `./icons/<name>` | One icon's components, for consumers that avoid barrels |
|
|
126
|
+
| `./brands` | Brand components |
|
|
127
|
+
| `./flags` | Country flag components (`BrFlagIcon`), 16 px high by default |
|
|
128
|
+
| `./flags/<name>` | One flag's component, for a dynamic import |
|
|
129
|
+
| `./native` | Every line, filled and 16 px icon as a React Native component, and the bases |
|
|
130
|
+
| `./native/icons/<name>` | One icon's React Native components, for a dynamic import |
|
|
131
|
+
| `./native/brands` | Brand components for React Native |
|
|
132
|
+
| `./native/flags` | Flag components for React Native |
|
|
133
|
+
| `./native/runtime` | The native base, `createNativeIcon` and their types |
|
|
134
|
+
| `./svg/*` | Raw SVG files (`svg/line/<name>.svg`, `filled`, `sm`, `brands`, `flags`) |
|
|
135
|
+
| `./sprite.svg` | The SVG sprite, one `<symbol>` per drawing |
|
|
136
|
+
| `./metadata.json` | Merged metadata of every icon, brand and flag |
|
|
140
137
|
|
|
141
138
|
A flag takes the props of an icon without `color`, `strokeWidth` and `absoluteStrokeWidth`, since
|
|
142
139
|
it keeps its own colours, and its `size` is its height: 16 by default, so a 3:2 flag is 24 by 16.
|
|
@@ -204,24 +201,12 @@ module imports `createIcon`, and the root re-exports every icon. Every JavaScrip
|
|
|
204
201
|
ships ESM (`.mjs`) and CommonJS (`.cjs`), each with its own declarations (`.d.ts` and
|
|
205
202
|
`.d.cts`).
|
|
206
203
|
|
|
207
|
-
### Install
|
|
208
|
-
|
|
209
|
-
```bash
|
|
210
|
-
pnpm add @bymax-one/icons react
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
### Peer dependency matrix
|
|
214
|
-
|
|
215
|
-
| Package | Version | Needed by |
|
|
216
|
-
| ------------------ | ---------------------- | ---------------------------------- |
|
|
217
|
-
| Node.js | `>=24.0.0` | Tooling and builds |
|
|
218
|
-
| `react` | `^19.0.0` | The root, `./brands` and `./flags` |
|
|
219
|
-
| `react-native-svg` | `>=15.11.1` (optional) | The `./native` entries |
|
|
220
|
-
|
|
221
204
|
---
|
|
222
205
|
|
|
223
206
|
## 🚀 Quick Start
|
|
224
207
|
|
|
208
|
+
### 1. Install
|
|
209
|
+
|
|
225
210
|
```bash
|
|
226
211
|
# pnpm
|
|
227
212
|
pnpm add @bymax-one/icons react
|
|
@@ -233,6 +218,16 @@ npm install @bymax-one/icons react
|
|
|
233
218
|
yarn add @bymax-one/icons react
|
|
234
219
|
```
|
|
235
220
|
|
|
221
|
+
`react` is the only peer dependency of the web entries; `react-native-svg` is an optional peer, needed only by the `./native` entries.
|
|
222
|
+
|
|
223
|
+
| Package | Version | Needed by |
|
|
224
|
+
| ------------------ | ---------------------- | ---------------------------------- |
|
|
225
|
+
| Node.js | `>=24.0.0` | Tooling and builds |
|
|
226
|
+
| `react` | `^19.0.0` | The root, `./brands` and `./flags` |
|
|
227
|
+
| `react-native-svg` | `>=15.11.1` (optional) | The `./native` entries |
|
|
228
|
+
|
|
229
|
+
### 2. Render an icon
|
|
230
|
+
|
|
236
231
|
The grid comes from the React-free entry:
|
|
237
232
|
|
|
238
233
|
```typescript
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymax-one/icons",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Original Bymax icon set for React 19: per-icon components, raw SVG, a sprite and typed metadata, drawn on one 24 px grid with a 1.5 px stroke.",
|
|
5
5
|
"author": "Bymax One <support@bymax.one>",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"homepage": "https://github.
|
|
7
|
+
"homepage": "https://bymaxone.github.io/icons/",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "git+https://github.com/bymaxone/icons.git"
|