@jirawatpyk/aura-react 5.8.0 → 5.10.0

package/dist/server/index.d.cts

@@ -239,6 +239,12 @@ export interface AuraStrings {
 	pageN: (p: number) => string;
 	accepts: (list?: string, max?: number | string) => string;
 }
+/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
+ * only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
+/** A whole language for AuraProvider `strings` (5.9): every built-in label, and assignable to the prop. */
+export type AuraLocalePack = AuraStrings & {
+	[key: string]: string | ((...args: any[]) => string);
+};
 export declare const STRINGS: {
 	en: AuraStrings;
 	th: AuraStrings;
@@ -270,6 +276,18 @@ export declare const breakpoints: {
 	lg: 1024;
 	xl: 1280;
 };
+/** One SVG child: element name and its attributes. */
+export type IconShape = [
+	string,
+	Record<string, string>
+];
+/** An AURA icon component from `@jirawatpyk/aura-react/icons` (5.9), e.g. `IconUsers`. */
+export type AuraIcon = React$1.ForwardRefExoticComponent<Omit<IconProps, "name"> & React$1.RefAttributes<SVGSVGElement>> & {
+	/** The icon's path data. */
+	readonly auraShapes: IconShape[];
+	/** Its name in the set, e.g. `users`. */
+	readonly iconName: string;
+};
 /** The class list of a Button (5.8): put it on your own link or `<Link>` to make it look like one, e.g. in a Server
  * Component — `<Link href="/renew" className={buttonClass({ variant: 'secondary' })}>Renew</Link>`. */
 export declare function buttonClass(opts?: {
@@ -284,6 +302,12 @@ declare function ServerCard(props: CardProps): React$1.ReactElement;
 declare function ServerStatusPill(props: StatusPillProps): React$1.ReactElement;
 declare function ServerBadge(props: BadgeProps): React$1.ReactElement;
 declare function ServerEmptyState(props: EmptyStateProps): React$1.ReactElement;
+/** Makes icon names as strings work: `registerIcons(allIcons)` once at startup, with `allIcons` from
+ * `@jirawatpyk/aura-react/icons`, or only the icons you use (`registerIcons([IconUsers, IconPlus])`). In 5.x every
+ * name already works and this only says you are ready for 6.0 (it silences the notice); in 6.0 it is required. Call it in the module
+ * graph that renders the names: a client module for the components, and also a server module if Server Components
+ * render names with `/server`'s Icon (the two entries keep separate registries). */
+export declare function registerIcons(icons: readonly AuraIcon[]): void;
 export declare const Icon: React$1.ForwardRefExoticComponent<IconProps & React$1.RefAttributes<SVGSVGElement>>;
 
 export {

package/dist/server/index.d.ts

@@ -239,6 +239,12 @@ export interface AuraStrings {
 	pageN: (p: number) => string;
 	accepts: (list?: string, max?: number | string) => string;
 }
+/** Built-in strings by locale. th and sv also ship as packs (`@jirawatpyk/aura-react/locales/th`, `/sv`, 5.9); in 6.0
+ * only en stays built in and a Thai or Swedish app passes its pack to AuraProvider `strings`. */
+/** A whole language for AuraProvider `strings` (5.9): every built-in label, and assignable to the prop. */
+export type AuraLocalePack = AuraStrings & {
+	[key: string]: string | ((...args: any[]) => string);
+};
 export declare const STRINGS: {
 	en: AuraStrings;
 	th: AuraStrings;
@@ -270,6 +276,18 @@ export declare const breakpoints: {
 	lg: 1024;
 	xl: 1280;
 };
+/** One SVG child: element name and its attributes. */
+export type IconShape = [
+	string,
+	Record<string, string>
+];
+/** An AURA icon component from `@jirawatpyk/aura-react/icons` (5.9), e.g. `IconUsers`. */
+export type AuraIcon = React$1.ForwardRefExoticComponent<Omit<IconProps, "name"> & React$1.RefAttributes<SVGSVGElement>> & {
+	/** The icon's path data. */
+	readonly auraShapes: IconShape[];
+	/** Its name in the set, e.g. `users`. */
+	readonly iconName: string;
+};
 /** The class list of a Button (5.8): put it on your own link or `<Link>` to make it look like one, e.g. in a Server
  * Component — `<Link href="/renew" className={buttonClass({ variant: 'secondary' })}>Renew</Link>`. */
 export declare function buttonClass(opts?: {
@@ -284,6 +302,12 @@ declare function ServerCard(props: CardProps): React$1.ReactElement;
 declare function ServerStatusPill(props: StatusPillProps): React$1.ReactElement;
 declare function ServerBadge(props: BadgeProps): React$1.ReactElement;
 declare function ServerEmptyState(props: EmptyStateProps): React$1.ReactElement;
+/** Makes icon names as strings work: `registerIcons(allIcons)` once at startup, with `allIcons` from
+ * `@jirawatpyk/aura-react/icons`, or only the icons you use (`registerIcons([IconUsers, IconPlus])`). In 5.x every
+ * name already works and this only says you are ready for 6.0 (it silences the notice); in 6.0 it is required. Call it in the module
+ * graph that renders the names: a client module for the components, and also a server module if Server Components
+ * render names with `/server`'s Icon (the two entries keep separate registries). */
+export declare function registerIcons(icons: readonly AuraIcon[]): void;
 export declare const Icon: React$1.ForwardRefExoticComponent<IconProps & React$1.RefAttributes<SVGSVGElement>>;
 
 export {