ikoneme-lib 0.3.0 → 0.4.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
@@ -131,6 +131,21 @@ import {
131
131
  `image` is the artwork as a data URI, `color` its main colour.
132
132
  - `getBorderImageStyle(border, size)` — inline style that draws a border's
133
133
  artwork around a square box of `size` px (what `<Ikon>` uses).
134
+ - `createEmptyIkon()` — an ikon with every zone empty and no border.
135
+
136
+ ### Image export
137
+
138
+ ```js
139
+ import { renderIkonemeToPng, renderIkonemeToCanvas, drawIkon } from 'ikoneme-lib'
140
+
141
+ const blob = await renderIkonemeToPng(ikons, { size: 120, perRow: 8, title: 'hello' })
142
+ ```
143
+
144
+ Draws ikons on a canvas with the same layout, tints and border artwork as
145
+ `<Ikon>`. Options: `size`, `gap`, `padding`, `perRow`, `background`, `title`,
146
+ `titleColor`, `titleFont`, `pixelRatio`. Remote icons are loaded with CORS, so
147
+ an image host without `Access-Control-Allow-Origin` is skipped (the browser
148
+ won't let it into an exportable canvas).
134
149
 
135
150
  ### IkonDB helpers
136
151
 
@@ -0,0 +1,13 @@
1
+ export function drawIkon(ctx: any, ikon: any, x: any, y: any, size: any): Promise<void>;
2
+ export function renderIkonemeToCanvas(ikons: any, { size, gap, padding, perRow, background, title, titleColor, titleFont, pixelRatio }?: {
3
+ size?: number;
4
+ gap?: number;
5
+ padding?: number;
6
+ perRow?: number;
7
+ background?: string;
8
+ title?: any;
9
+ titleColor?: string;
10
+ titleFont?: string;
11
+ pixelRatio?: number;
12
+ }): Promise<HTMLCanvasElement>;
13
+ export function renderIkonemeToPng(ikons: any, options: any): Promise<any>;
@@ -0,0 +1,69 @@
1
+ export function getIkonPaddings(size: any): {
2
+ framePad: number;
3
+ zonePad: number;
4
+ rootPad: number;
5
+ };
6
+ export function trackOffsets(length: any, weights: any): number[];
7
+ export const EDGE_FR: 1.18;
8
+ export const MID_FR: 0.95;
9
+ export const TRACK_WEIGHTS: number[];
10
+ export const REF_WEIGHTS: number[];
11
+ export namespace ZONE_BACKGROUNDS {
12
+ let context: string;
13
+ let reference: string;
14
+ let role: string;
15
+ let modes: string;
16
+ let root: string;
17
+ let east: string;
18
+ let tenses: string;
19
+ }
20
+ export const ZONE_DIVIDER: "rgba(0, 0, 0, 0.14)";
21
+ export namespace ZONE_GRID {
22
+ export namespace context_1 {
23
+ let cols: number[];
24
+ let rows: number[];
25
+ }
26
+ export { context_1 as context };
27
+ export namespace reference_1 {
28
+ let cols_1: number[];
29
+ export { cols_1 as cols };
30
+ let rows_1: number[];
31
+ export { rows_1 as rows };
32
+ }
33
+ export { reference_1 as reference };
34
+ export namespace role_1 {
35
+ let cols_2: number[];
36
+ export { cols_2 as cols };
37
+ let rows_2: number[];
38
+ export { rows_2 as rows };
39
+ }
40
+ export { role_1 as role };
41
+ export namespace modes_1 {
42
+ let cols_3: number[];
43
+ export { cols_3 as cols };
44
+ let rows_3: number[];
45
+ export { rows_3 as rows };
46
+ }
47
+ export { modes_1 as modes };
48
+ export namespace root_1 {
49
+ let cols_4: number[];
50
+ export { cols_4 as cols };
51
+ let rows_4: number[];
52
+ export { rows_4 as rows };
53
+ }
54
+ export { root_1 as root };
55
+ export namespace east_1 {
56
+ let cols_5: number[];
57
+ export { cols_5 as cols };
58
+ let rows_5: number[];
59
+ export { rows_5 as rows };
60
+ }
61
+ export { east_1 as east };
62
+ export namespace tenses_1 {
63
+ let cols_6: number[];
64
+ export { cols_6 as cols };
65
+ let rows_6: number[];
66
+ export { rows_6 as rows };
67
+ }
68
+ export { tenses_1 as tenses };
69
+ }
@@ -5,6 +5,10 @@ export function getBorderConfig(borderId: any): {
5
5
  plural: boolean;
6
6
  image: any;
7
7
  };
8
+ export function getBorderMetrics(size: any): {
9
+ frame: number;
10
+ corner: number;
11
+ };
8
12
  export function getBorderImageStyle(border: any, size: any): {
9
13
  borderStyle?: undefined;
10
14
  borderColor?: undefined;
@@ -58,6 +62,19 @@ export function createDefaultIkon(): {
58
62
  };
59
63
  border: any;
60
64
  };
65
+ export function createEmptyIkon(): {
66
+ context: any;
67
+ reference: {
68
+ left: any;
69
+ right: any;
70
+ };
71
+ role: any;
72
+ modes: any;
73
+ root: any;
74
+ rootName: any;
75
+ tenses: any;
76
+ border: any;
77
+ };
61
78
  export function normalizeIkon(icon: any): any;
62
79
  export function normalizeIkoneme(ikons: any): any;
63
80
  export function generateIkonemeFromText(text: any): Promise<any[]>;