@fusion.dev/helix-docs 0.99.0 → 0.100.0

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.
@@ -119,7 +119,41 @@ consumer's 15 kB to about 90.
119
119
  Only the default weight carries that index, so `name` draws bold. A consumer who
120
120
  wants the set in another weight imports the values and hands them over.
121
121
 
122
- ## Adding one
122
+ ## A set of your own
123
+
124
+ The generator that builds this set is the package's own command, so you are not
125
+ waiting on us to carry a glyph:
126
+
127
+ ```sh
128
+ npx helix-icons build --source ./brand-icons --out src/icons.ts
129
+ ```
130
+
131
+ ```tsx
132
+ import { peak } from './icons'
133
+
134
+ <helix-icon icon={peak} />
135
+ ```
136
+
137
+ It reads a directory of SVG files and writes the module the element draws from,
138
+ which is the same job whether the drawings are yours, another library's, or the
139
+ 1,404 Phosphor glyphs this set does not carry:
140
+
141
+ ```sh
142
+ npx helix-icons build \
143
+ --source node_modules/@phosphor-icons/core/assets/regular \
144
+ --list mine.txt --out src/icons.ts
145
+ ```
146
+
147
+ `--suffix` is for a set that spells the weight into the file name, Phosphor's
148
+ bold being `caret-down-bold.svg`. `--index` also writes the record `name` reads,
149
+ which you want if your own elements take a name in markup and do not want
150
+ otherwise, since it is the part nothing can drop.
151
+
152
+ **A name in two sources is refused rather than decided.** A precedence decides
153
+ silently, and the glyph on the page would be whichever directory sat higher with
154
+ nothing looking wrong afterwards.
155
+
156
+ ## Adding one to this set
123
157
 
124
158
  Add the name to `helix/icons/icons.txt` and run `turbo run icons`. Phosphor names
125
159
  resolve from `@phosphor-icons/core` at build time, so adding a glyph is adding a
@@ -396,7 +396,7 @@ column is what was removed rather than part of what remains.
396
396
  |---|---|---|---|---|
397
397
  | `@fusion.dev/helix-core` | 984,477 | 153 | 222,482 | `@floating-ui/dom`, `@fusion.dev/helix-icons` |
398
398
  | `@fusion.dev/helix-headless` | 11,366,181 | 464 | 836,952 | `@fusion.dev/helix-core`, `@fusion.dev/helix-icons`, `uqr` |
399
- | `@fusion.dev/helix-icons` | 121,091 | 17 | 37,263 | none |
399
+ | `@fusion.dev/helix-icons` | 131,512 | 21 | 44,809 | `svgo` |
400
400
  | `@fusion.dev/helix-styles` | 101,139 | 6 | 0 | none |
401
401
  | `@fusion.dev/helix-theme` | 465,413 | 8 | 4,703 | none |
402
402
  | `@fusion.dev/helix` | 12,499,093 | 796 | 333,986 | `@fusion.dev/helix-core`, `@fusion.dev/helix-headless`, `@fusion.dev/helix-styles` |
@@ -1570,7 +1570,41 @@ consumer's 15 kB to about 90.
1570
1570
  Only the default weight carries that index, so \`name\` draws bold. A consumer who
1571
1571
  wants the set in another weight imports the values and hands them over.
1572
1572
 
1573
- ## Adding one
1573
+ ## A set of your own
1574
+
1575
+ The generator that builds this set is the package's own command, so you are not
1576
+ waiting on us to carry a glyph:
1577
+
1578
+ \`\`\`sh
1579
+ npx helix-icons build --source ./brand-icons --out src/icons.ts
1580
+ \`\`\`
1581
+
1582
+ \`\`\`tsx
1583
+ import { peak } from './icons'
1584
+
1585
+ <helix-icon icon={peak} />
1586
+ \`\`\`
1587
+
1588
+ It reads a directory of SVG files and writes the module the element draws from,
1589
+ which is the same job whether the drawings are yours, another library's, or the
1590
+ 1,404 Phosphor glyphs this set does not carry:
1591
+
1592
+ \`\`\`sh
1593
+ npx helix-icons build \\
1594
+ --source node_modules/@phosphor-icons/core/assets/regular \\
1595
+ --list mine.txt --out src/icons.ts
1596
+ \`\`\`
1597
+
1598
+ \`--suffix\` is for a set that spells the weight into the file name, Phosphor's
1599
+ bold being \`caret-down-bold.svg\`. \`--index\` also writes the record \`name\` reads,
1600
+ which you want if your own elements take a name in markup and do not want
1601
+ otherwise, since it is the part nothing can drop.
1602
+
1603
+ **A name in two sources is refused rather than decided.** A precedence decides
1604
+ silently, and the glyph on the page would be whichever directory sat higher with
1605
+ nothing looking wrong afterwards.
1606
+
1607
+ ## Adding one to this set
1574
1608
 
1575
1609
  Add the name to \`helix/icons/icons.txt\` and run \`turbo run icons\`. Phosphor names
1576
1610
  resolve from \`@phosphor-icons/core\` at build time, so adding a glyph is adding a
@@ -2428,7 +2462,7 @@ column is what was removed rather than part of what remains.
2428
2462
  |---|---|---|---|---|
2429
2463
  | \`@fusion.dev/helix-core\` | 984,477 | 153 | 222,482 | \`@floating-ui/dom\`, \`@fusion.dev/helix-icons\` |
2430
2464
  | \`@fusion.dev/helix-headless\` | 11,366,181 | 464 | 836,952 | \`@fusion.dev/helix-core\`, \`@fusion.dev/helix-icons\`, \`uqr\` |
2431
- | \`@fusion.dev/helix-icons\` | 121,091 | 17 | 37,263 | none |
2465
+ | \`@fusion.dev/helix-icons\` | 131,512 | 21 | 44,809 | \`svgo\` |
2432
2466
  | \`@fusion.dev/helix-styles\` | 101,139 | 6 | 0 | none |
2433
2467
  | \`@fusion.dev/helix-theme\` | 465,413 | 8 | 4,703 | none |
2434
2468
  | \`@fusion.dev/helix\` | 12,499,093 | 796 | 333,986 | \`@fusion.dev/helix-core\`, \`@fusion.dev/helix-headless\`, \`@fusion.dev/helix-styles\` |
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@fusion.dev/helix-docs",
3
3
  "description": "Versioned documentation content and registry for Helix.",
4
- "version": "0.99.0",
4
+ "version": "0.100.0",
5
5
  "license": "MIT",
6
6
  "author": "Ross Sheppard <ross.sheppard@fusion.dev>",
7
7
  "repository": {
@@ -36,8 +36,8 @@
36
36
  },
37
37
  "bugs": "https://github.com/project-fusion/fusion/issues",
38
38
  "devDependencies": {
39
- "@fusion.dev/helix-cem": "0.99.0",
40
- "@fusion.dev/helix-testing": "0.99.0",
39
+ "@fusion.dev/helix-cem": "0.100.0",
40
+ "@fusion.dev/helix-testing": "0.100.0",
41
41
  "@fusion.dev/scripts": "0.0.0-dev",
42
42
  "lit": "^3.2.1",
43
43
  "playwright": "^1.62.1"