@luscious-garden/aster-icons 0.1.0-rc.1 → 0.1.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.
package/README.md CHANGED
@@ -11,9 +11,10 @@ The package contains no renderer, framework, DOM, filesystem, Import, or global
11
11
  dependency.
12
12
  The example below assumes `@luscious-garden/aster-svg` is installed independently by the consumer.
13
13
 
14
- When `0.1.0-rc.1` is published, install both packages for this example with
15
- `pnpm add @luscious-garden/aster-icons@0.1.0-rc.1 @luscious-garden/aster-svg@0.1.0-rc.1`. To use a definition without SVG rendering,
16
- install only `@luscious-garden/aster-icons`; it brings its compatible Core dependency.
14
+ Install both packages for this example with
15
+ `pnpm add @luscious-garden/aster-icons@0.1.0 @luscious-garden/aster-svg@0.1.0`.
16
+ To use a definition without SVG rendering, install only `@luscious-garden/aster-icons`; it brings
17
+ its compatible Core dependency.
17
18
 
18
19
  Canonical `*.icon.ts` and `*.collection.ts` modules are editable sources. Package builds
19
20
  deterministically synchronise their manifests, exact loader maps and stable public facades before
@@ -26,10 +27,26 @@ import { Svg } from "@luscious-garden/aster-svg";
26
27
  const markup = Svg.render(ArrowLeft);
27
28
  ```
28
29
 
30
+ Collections expose icons by typed local alias and provide an ordered list for iteration:
31
+
32
+ ```ts
33
+ import { AmellusCollection } from "@luscious-garden/aster-icons/collections/amellus";
34
+
35
+ const cameraMarkup = Svg.render(AmellusCollection.icons.camera);
36
+ const collectionMarkup = AmellusCollection.members.map((icon) => Svg.render(icon));
37
+ ```
38
+
39
+ Both views contain the same canonical icon objects. Importing Amellus evaluates all its declared
40
+ members even when only `.icons.camera` is read; import `@luscious-garden/aster-icons/camera` directly
41
+ when only that icon is needed.
42
+
43
+ The [release notes](https://github.com/BlueLuscious/aster/blob/master/docs/en/packages/icons/releases.md)
44
+ describe migration from earlier candidates.
45
+
29
46
  The package currently provides the accepted Amellus foundational collection. See the
30
47
  [canonical package documentation](https://github.com/BlueLuscious/aster/blob/master/docs/en/packages/icons/index.md),
31
48
  [authoring workflow](https://github.com/BlueLuscious/aster/blob/master/docs/en/packages/icons/workflow.md),
32
- [initial release notes](https://github.com/BlueLuscious/aster/blob/master/docs/en/packages/icons/releases.md) and
49
+ [release notes](https://github.com/BlueLuscious/aster/blob/master/docs/en/packages/icons/releases.md) and
33
50
  [Amellus collection authority](https://github.com/BlueLuscious/aster/blob/master/docs/en/collections/amellus/index.md).
34
51
 
35
52
  ## Licence
@@ -1,4 +1,31 @@
1
1
  /**
2
2
  * @description Canonical Amellus collection containing the foundational general-purpose icon set.
3
3
  */
4
- export declare const AmellusCollection: import("@luscious-garden/aster-core").CollectionDefinition;
4
+ export declare const AmellusCollection: import("@luscious-garden/aster-core").CollectionDefinition<{
5
+ arrowLeft: import("@luscious-garden/aster-core").IconDefinition;
6
+ arrowRight: import("@luscious-garden/aster-core").IconDefinition;
7
+ arrowUp: import("@luscious-garden/aster-core").IconDefinition;
8
+ arrowDown: import("@luscious-garden/aster-core").IconDefinition;
9
+ home: import("@luscious-garden/aster-core").IconDefinition;
10
+ menu: import("@luscious-garden/aster-core").IconDefinition;
11
+ check: import("@luscious-garden/aster-core").IconDefinition;
12
+ close: import("@luscious-garden/aster-core").IconDefinition;
13
+ download: import("@luscious-garden/aster-core").IconDefinition;
14
+ plus: import("@luscious-garden/aster-core").IconDefinition;
15
+ search: import("@luscious-garden/aster-core").IconDefinition;
16
+ settings: import("@luscious-garden/aster-core").IconDefinition;
17
+ heart: import("@luscious-garden/aster-core").IconDefinition;
18
+ info: import("@luscious-garden/aster-core").IconDefinition;
19
+ lock: import("@luscious-garden/aster-core").IconDefinition;
20
+ star: import("@luscious-garden/aster-core").IconDefinition;
21
+ warning: import("@luscious-garden/aster-core").IconDefinition;
22
+ camera: import("@luscious-garden/aster-core").IconDefinition;
23
+ pause: import("@luscious-garden/aster-core").IconDefinition;
24
+ play: import("@luscious-garden/aster-core").IconDefinition;
25
+ bell: import("@luscious-garden/aster-core").IconDefinition;
26
+ mail: import("@luscious-garden/aster-core").IconDefinition;
27
+ cloud: import("@luscious-garden/aster-core").IconDefinition;
28
+ folder: import("@luscious-garden/aster-core").IconDefinition;
29
+ leaf: import("@luscious-garden/aster-core").IconDefinition;
30
+ user: import("@luscious-garden/aster-core").IconDefinition;
31
+ }>;
@@ -33,34 +33,34 @@ export const AmellusCollection = Collection.define({
33
33
  identity: {
34
34
  name: "amellus",
35
35
  },
36
- icons: [
37
- ArrowLeft,
38
- ArrowRight,
39
- ArrowUp,
40
- ArrowDown,
41
- Home,
42
- Menu,
43
- Check,
44
- Close,
45
- Download,
46
- Plus,
47
- Search,
48
- Settings,
49
- Heart,
50
- Info,
51
- Lock,
52
- Star,
53
- Warning,
54
- Camera,
55
- Pause,
56
- Play,
57
- Bell,
58
- Mail,
59
- Cloud,
60
- Folder,
61
- Leaf,
62
- User,
63
- ],
36
+ icons: {
37
+ arrowLeft: ArrowLeft,
38
+ arrowRight: ArrowRight,
39
+ arrowUp: ArrowUp,
40
+ arrowDown: ArrowDown,
41
+ home: Home,
42
+ menu: Menu,
43
+ check: Check,
44
+ close: Close,
45
+ download: Download,
46
+ plus: Plus,
47
+ search: Search,
48
+ settings: Settings,
49
+ heart: Heart,
50
+ info: Info,
51
+ lock: Lock,
52
+ star: Star,
53
+ warning: Warning,
54
+ camera: Camera,
55
+ pause: Pause,
56
+ play: Play,
57
+ bell: Bell,
58
+ mail: Mail,
59
+ cloud: Cloud,
60
+ folder: Folder,
61
+ leaf: Leaf,
62
+ user: User,
63
+ },
64
64
  metadata: {
65
65
  displayName: "Amellus",
66
66
  description: "Minimalist general-purpose outline icons for application interfaces.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@luscious-garden/aster-icons",
3
- "version": "0.1.0-rc.1",
3
+ "version": "0.1.0",
4
4
  "description": "Canonical portable Aster icon and collection definitions.",
5
5
  "type": "module",
6
6
  "author": "BlueLuscious",
@@ -43,7 +43,7 @@
43
43
  "dist"
44
44
  ],
45
45
  "dependencies": {
46
- "@luscious-garden/aster-core": "^0.1.0-rc.1"
46
+ "@luscious-garden/aster-core": "^0.1.0"
47
47
  },
48
48
  "scripts": {
49
49
  "build": "pnpm run generate:catalogue && pnpm run clean && tsc -p tsconfig.json",