@nxgt/material-core 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @nxgt/material-core
 
+## 0.6.0
+
+### Minor Changes
+
+- [#468](https://github.com/softistx/nxgt-material/pull/468) [`5f984fa`](https://github.com/softistx/nxgt-material/commit/5f984fa95a2944e6c71acd81d0272730d87c2c0a) Thanks [@SteveGT96](https://github.com/SteveGT96)! - New subpath `@nxgt/material-core/emoji-groups`: `groupKey`, `groupEmojis`, `searchEmojis`, `groupName`, `GROUP_NAMES` and the type `EmojiItem`, the emoji list's grouping, search and group names that both libraries kept a copy of.
+
+### Patch Changes
+
+- [#470](https://github.com/softistx/nxgt-material/pull/470) [`853d093`](https://github.com/softistx/nxgt-material/commit/853d093f0620dc6940ea1ce69e025b61e3b0094d) Thanks [@SteveGT96](https://github.com/SteveGT96)! - The roadmap names the release that ships the two Tabs looks and the emoji groups.
+
 ## 0.5.0
 
 ### Minor Changes

package/README.md

@@ -5,9 +5,9 @@ The framework-free core that [`@nxgt/material`](https://www.npmjs.com/package/@n
 (Vue) share, as one copy: the PDF document model and its react-pdf renderer,
 the print formatters, the PDF file helpers, the PDF viewer's framework-free
 half (page geometry, scroll spy, text search), the currency field's decimals,
-the file-size formatter, the slider's tick marks, the date range presets, the
-file preview's kind detection, the fields' blur rule, a field's first
-reachable control (`/focus-control`) and its `aria-describedby`
+the file-size formatter, the slider's tick marks, the emoji list's groups,
+the date range presets, the file preview's kind detection, the fields' blur
+rule, a field's first reachable control (`/focus-control`) and its `aria-describedby`
 (`/described-by`), the page behind a modal layer made inert
 (`/inert-others`), Escape pressed while an overlay closes
 (`/escape-forward`), the Toaster's guard against a tap's emulated hover
@@ -89,6 +89,7 @@ built-in.
 | `/row-activation` | `isRowActivation`, `followRowLink`, `ROW_CONTROL_SELECTOR`, `ROW_LINK_SELECTOR`, `RowClick` — whether a click on a table row follows its link, and following it |
 | `/format-file-size` | `formatFileSize` — a byte count as `'1.5 KB'` |
 | `/slider-ticks` | `tickValues` — where a slider's tick marks sit |
+| `/emoji-groups` | `groupKey`, `groupEmojis`, `searchEmojis`, `groupName`, `GROUP_NAMES` and the type `EmojiItem` — how the emoji list groups, searches and names its emojis |
 | `/date-range` | `DATE_RANGE_PRESET_IDS`, `presetRange`, `resolvePresetRange`, `isSameDayRange`, `isRangeDisabled`, `withTimeOf`, `endOfDayTime`, `clampRangeEnd`, `keepRangeTimes` and the types `DayRange`, `PartialDayRange`, `DateRangePreset`, `DateRangePresetId`, `DateRangePresetOption`, `DateRangeRules` — `DateRangeField`'s presets and times |
 | `/file-preview` | `fileKind`, `describeFile`, `safePreviewUrl`, `readTextPreview`, `FilePreviewHttpError`, `FilePreviewUnsafeUrlError`, `TEXT_PREVIEW_MAX_BYTES`, `fileExtension`, `fileNameFromUrl`, `dataUrlType`, `kindOfMimeType`, `normaliseMimeType`, `isTextFileKind`, `TEXT_FILE_KINDS` and the types `FileKind`, `FileKindInput`, `DescribedFile`, `FilePreviewSource`, `TextPreview` — `FilePreview`'s kind detection, URL allow-list and text reader |
 | `/vite` | `pdfkitStandardFonts()` — see below |
@@ -372,6 +373,22 @@ tickValues(0, 100, true, 1).length; // 21 — capped
 tickValues(5, 5, true); // [5] — min === max
 ```
 
+### The emoji list's groups: `/emoji-groups`
+
+How both libraries' `EmojiList` groups, searches and names its emojis:
+`groupKey` turns a catalog group into a key, `groupEmojis` builds the tabs
+(`all`, `recent`, then one per group), `searchEmojis` filters by name or
+shortcode, `groupName` gives a key's English name (a key it does not know
+reads as its words).
+
+```ts
+import { groupName, searchEmojis } from '@nxgt/material-core/emoji-groups';
+
+groupName('people_body'); // 'People & body'
+groupName('hand_signs'); // 'Hand signs'
+searchEmojis([{ name: 'fire' }], 'FIR'); // [{ name: 'fire' }]
+```
+
 ### A date range's presets and times: `/date-range`
 
 The pure half of both libraries' `DateRangeField` (`presets`, `withTime` /

package/dist/lib/emoji-groups.d.ts

@@ -0,0 +1,20 @@
+/** What the grouping functions read of an emoji. */
+export type EmojiItem = {
+    name: string;
+    emoji?: string;
+    group?: string | null;
+    shortcodes?: string[];
+};
+export declare function groupKey(group?: string | null): string;
+export declare function groupEmojis(emojis: EmojiItem[], recent: string[]): {
+    [k: string]: EmojiItem[];
+};
+export declare function searchEmojis(emojis: EmojiItem[], query: string): EmojiItem[] | null;
+export declare const GROUP_NAMES: Record<string, string>;
+/**
+ * A group's English name, the fallback of `material.emoji.groups.<key>`: the
+ * name of the icon-only tab that shows it. A key the bundles do not name
+ * (`hand_signs`) reads as its words (`Hand signs`).
+ */
+export declare function groupName(key: string): string;
+//# sourceMappingURL=emoji-groups.d.ts.map

package/dist/lib/emoji-groups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emoji-groups.d.ts","sourceRoot":"","sources":["../../src/lib/emoji-groups.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,MAAM,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,wBAAgB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,UAI7C;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;;EAehE;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,sBAO9D;AAED,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAa9C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,UAGpC"}

package/dist/lib/emoji-groups.js

@@ -0,0 +1,58 @@
+// src/lib/emoji-groups.ts
+function groupKey(group) {
+  const raw = group?.trim();
+  if (!raw)
+    return "general";
+  return raw.toLowerCase().replace(/ & /g, "_").replace(/\s+/g, "_");
+}
+function groupEmojis(emojis, recent) {
+  const groups = {
+    all: emojis
+  };
+  const recentItems = recent.map((name) => emojis.find((item) => item.name === name)).filter((item) => Boolean(item));
+  if (recentItems.length > 0)
+    groups.recent = recentItems;
+  for (const item of emojis) {
+    const key = groupKey(item.group);
+    groups[key] = [...groups[key] ?? [], item];
+  }
+  return Object.fromEntries(Object.entries(groups).filter(([, items]) => items.length > 0));
+}
+function searchEmojis(emojis, query) {
+  const needle = query.trim().toLowerCase();
+  if (!needle)
+    return null;
+  return emojis.filter((item) => {
+    if (item.name.toLowerCase().includes(needle))
+      return true;
+    return item.shortcodes?.some((code) => code.toLowerCase().includes(needle));
+  });
+}
+var GROUP_NAMES = {
+  all: "All",
+  recent: "Recent",
+  general: "General",
+  people_body: "People & body",
+  components: "Components",
+  animals_nature: "Animals & nature",
+  food_drink: "Food & drink",
+  travel_places: "Travel & places",
+  activities: "Activities",
+  objects: "Objects",
+  symbols: "Symbols",
+  flags: "Flags"
+};
+function groupName(key) {
+  const words = key.replace(/_/g, " ");
+  return GROUP_NAMES[key] ?? words.charAt(0).toUpperCase() + words.slice(1);
+}
+export {
+  GROUP_NAMES,
+  groupEmojis,
+  groupKey,
+  groupName,
+  searchEmojis
+};
+
+//# debugId=78A2C18812F7925A64756E2164756E21
+//# sourceMappingURL=emoji-groups.js.map

package/dist/lib/emoji-groups.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/lib/emoji-groups.ts"],
+  "sourcesContent": [
+    "/** What the grouping functions read of an emoji. */\nexport type EmojiItem = {\n\tname: string;\n\temoji?: string;\n\tgroup?: string | null;\n\tshortcodes?: string[];\n};\n\nexport function groupKey(group?: string | null) {\n\tconst raw = group?.trim();\n\tif (!raw) return 'general';\n\treturn raw.toLowerCase().replace(/ & /g, '_').replace(/\\s+/g, '_');\n}\n\nexport function groupEmojis(emojis: EmojiItem[], recent: string[]) {\n\tconst groups: Record<string, EmojiItem[]> = {\n\t\tall: emojis,\n\t};\n\tconst recentItems = recent\n\t\t.map((name) => emojis.find((item) => item.name === name))\n\t\t.filter((item): item is EmojiItem => Boolean(item));\n\tif (recentItems.length > 0) groups.recent = recentItems;\n\tfor (const item of emojis) {\n\t\tconst key = groupKey(item.group);\n\t\tgroups[key] = [...(groups[key] ?? []), item];\n\t}\n\treturn Object.fromEntries(\n\t\tObject.entries(groups).filter(([, items]) => items.length > 0),\n\t);\n}\n\nexport function searchEmojis(emojis: EmojiItem[], query: string) {\n\tconst needle = query.trim().toLowerCase();\n\tif (!needle) return null;\n\treturn emojis.filter((item) => {\n\t\tif (item.name.toLowerCase().includes(needle)) return true;\n\t\treturn item.shortcodes?.some((code) => code.toLowerCase().includes(needle));\n\t});\n}\n\nexport const GROUP_NAMES: Record<string, string> = {\n\tall: 'All',\n\trecent: 'Recent',\n\tgeneral: 'General',\n\tpeople_body: 'People & body',\n\tcomponents: 'Components',\n\tanimals_nature: 'Animals & nature',\n\tfood_drink: 'Food & drink',\n\ttravel_places: 'Travel & places',\n\tactivities: 'Activities',\n\tobjects: 'Objects',\n\tsymbols: 'Symbols',\n\tflags: 'Flags',\n};\n\n/**\n * A group's English name, the fallback of `material.emoji.groups.<key>`: the\n * name of the icon-only tab that shows it. A key the bundles do not name\n * (`hand_signs`) reads as its words (`Hand signs`).\n */\nexport function groupName(key: string) {\n\tconst words = key.replace(/_/g, ' ');\n\treturn GROUP_NAMES[key] ?? words.charAt(0).toUpperCase() + words.slice(1);\n}\n"
+  ],
+  "mappings": ";AAQO,SAAS,QAAQ,CAAC,OAAuB;AAAA,EAC/C,MAAM,MAAM,OAAO,KAAK;AAAA,EACxB,IAAI,CAAC;AAAA,IAAK,OAAO;AAAA,EACjB,OAAO,IAAI,YAAY,EAAE,QAAQ,QAAQ,GAAG,EAAE,QAAQ,QAAQ,GAAG;AAAA;AAG3D,SAAS,WAAW,CAAC,QAAqB,QAAkB;AAAA,EAClE,MAAM,SAAsC;AAAA,IAC3C,KAAK;AAAA,EACN;AAAA,EACA,MAAM,cAAc,OAClB,IAAI,CAAC,SAAS,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,EACvD,OAAO,CAAC,SAA4B,QAAQ,IAAI,CAAC;AAAA,EACnD,IAAI,YAAY,SAAS;AAAA,IAAG,OAAO,SAAS;AAAA,EAC5C,WAAW,QAAQ,QAAQ;AAAA,IAC1B,MAAM,MAAM,SAAS,KAAK,KAAK;AAAA,IAC/B,OAAO,OAAO,CAAC,GAAI,OAAO,QAAQ,CAAC,GAAI,IAAI;AAAA,EAC5C;AAAA,EACA,OAAO,OAAO,YACb,OAAO,QAAQ,MAAM,EAAE,OAAO,IAAI,WAAW,MAAM,SAAS,CAAC,CAC9D;AAAA;AAGM,SAAS,YAAY,CAAC,QAAqB,OAAe;AAAA,EAChE,MAAM,SAAS,MAAM,KAAK,EAAE,YAAY;AAAA,EACxC,IAAI,CAAC;AAAA,IAAQ,OAAO;AAAA,EACpB,OAAO,OAAO,OAAO,CAAC,SAAS;AAAA,IAC9B,IAAI,KAAK,KAAK,YAAY,EAAE,SAAS,MAAM;AAAA,MAAG,OAAO;AAAA,IACrD,OAAO,KAAK,YAAY,KAAK,CAAC,SAAS,KAAK,YAAY,EAAE,SAAS,MAAM,CAAC;AAAA,GAC1E;AAAA;AAGK,IAAM,cAAsC;AAAA,EAClD,KAAK;AAAA,EACL,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,SAAS;AAAA,EACT,SAAS;AAAA,EACT,OAAO;AACR;AAOO,SAAS,SAAS,CAAC,KAAa;AAAA,EACtC,MAAM,QAAQ,IAAI,QAAQ,MAAM,GAAG;AAAA,EACnC,OAAO,YAAY,QAAQ,MAAM,OAAO,CAAC,EAAE,YAAY,IAAI,MAAM,MAAM,CAAC;AAAA;",
+  "debugId": "78A2C18812F7925A64756E2164756E21",
+  "names": []
+}

package/docs/roadmap.md

@@ -64,6 +64,8 @@ Nothing in progress right now; see Next.
 - **Slider ticks** (`/slider-ticks`) — the values a slider's tick marks sit
   at, which both libraries' `SliderField` (`ticks`) read from here instead of
   keeping a copy each. 0.3.0.
+- **Emoji groups** (`/emoji-groups`) — how the emoji list groups, searches
+  and names its emojis, which both libraries' `EmojiList` read from here. 0.6.0.
 - **`formatFileSize` and the pdfkit fonts resolution** — the byte-count
   formatter both libraries' file list and upload field use
   (`/format-file-size`), and the Node-only resolution of pdfkit's standard

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nxgt/material-core",
-	"version": "0.5.0",
+	"version": "0.6.0",
 	"description": "The framework-free core of @nxgt/material and @nxgt/material-vue: the PDF document model and its react-pdf renderer, print formatters, PDF file helpers, the PDF viewer's pure modules, the currency digits, the file-size formatter, the field-blur layers, a field's first focusable control, the aria-describedby joiner, the inert background of a modal layer, Escape forwarded while an overlay closes, the Toaster's touch-hover guard, the zod issue messages, the date range presets, the file preview's kind detection and text reader, the pdfkit fonts Vite plugin and the Node-only pdfkit fonts resolution for Next.js and Nuxt builds",
 	"license": "MIT",
 	"bugs": {
@@ -138,6 +138,11 @@
 			"import": "./dist/lib/slider-ticks.js",
 			"default": "./dist/lib/slider-ticks.js"
 		},
+		"./emoji-groups": {
+			"types": "./dist/lib/emoji-groups.d.ts",
+			"import": "./dist/lib/emoji-groups.js",
+			"default": "./dist/lib/emoji-groups.js"
+		},
 		"./date-range": {
 			"types": "./dist/lib/date-range.d.ts",
 			"import": "./dist/lib/date-range.js",
@@ -216,6 +221,7 @@
 			"src/lib/row-activation.ts",
 			"src/lib/format-file-size.ts",
 			"src/lib/slider-ticks.ts",
+			"src/lib/emoji-groups.ts",
 			"src/lib/date-range.ts",
 			"src/file-preview/index.ts",
 			"src/pdf-viewer/index.ts",