@gouvfr-lasuite/ui-kit 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { Context } from 'react';
 import { CunninghamProvider as CunninghamProvider_2 } from '@openfun/cunningham-react';
 import { CursorProps } from 'react-arborist';
+import { default as default_2 } from 'react';
 import { Dispatch } from 'react';
 import { JSX } from 'react/jsx-runtime';
 import { Key } from 'react-stately';
@@ -64,6 +65,8 @@ export declare type BaseTreeViewData<T> = {
     nodeType?: Exclude<TreeViewNodeTypeEnum, TreeViewNodeTypeEnum.TITLE | TreeViewNodeTypeEnum.SEPARATOR>;
 } & T));
 
+export declare const containerSizeMap: Record<IconSize, number>;
+
 export declare const cunninghamConfig: {
     themes: {
         default: {
@@ -443,11 +446,25 @@ export declare type FilterProps = {
 
 export declare const Footer: () => JSX.Element;
 
+export declare const getContainerSize: (iconSize: IconSize) => number;
+
+export declare const getIconSize: (iconSize: IconSize) => number;
+
 export declare function getLocales(): {
     "en-US": any;
     "fr-FR": any;
 };
 
+/**
+ * Get a consistent avatar's color according to a hash of the name
+ */
+export declare const getUserColor: (name: string) => string;
+
+/**
+ * Split the name into parts and return the first two initials
+ */
+export declare const getUserInitials: (name: string) => string;
+
 export declare const Header: ({ leftIcon, rightIcon, languages, onTogglePanel, isPanelOpen, }: HeaderProps) => JSX.Element;
 
 export declare const headerHeight = 52;
@@ -474,6 +491,50 @@ export declare const HomeGutter: ({ children }: {
 
 export declare const HorizontalSeparator: ({ withPadding }: Props_3) => JSX.Element;
 
+export declare const Icon: default_2.FC<IconProps>;
+
+export declare type IconProps = {
+    /**
+     * The name of the Material Icon to display
+     */
+    name: string;
+    /**
+     * The type of the icon
+     */
+    type?: IconType;
+    /**
+     * The size of the icon
+     */
+    size?: IconSize | number;
+    /**
+     * Custom CSS class name
+     */
+    className?: string;
+    /**
+     * Custom color for the icon
+     */
+    color?: string;
+    /**
+     * Additional props to pass to the span element
+     */
+    [key: string]: unknown;
+};
+
+export declare enum IconSize {
+    X_SMALL = "xsmall",
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large",
+    X_LARGE = "xlarge"
+}
+
+export declare const iconSizeMap: Record<IconSize, number>;
+
+export declare enum IconType {
+    OUTLINED = "outlined",
+    FILLED = "filled"
+}
+
 export declare type InvitationData<UserType, T> = T & {
     id: string;
     role: string;