jattac.libs.web.zest-button 1.2.2 → 1.2.4

package/README.md

@@ -37,13 +37,15 @@ export default App;
 
 ### Documentation
 
+To get started, check out our **Cookbook** of practical recipes.
+
 | Topic | Description |
 | :--- | :--- |
-| **[Features](./docs/features.md)** | A guided tour of all component features with live examples. |
-| **[API Reference](./docs/api.md)** | An exhaustive technical reference for all props and type definitions. |
-| **[Examples](./docs/examples.md)** | A cookbook of practical, real-world examples for common use cases. |
-| **[Configuration](./docs/configuration.md)**| A guide to configuring themes and other component-wide settings. |
-| **[Development](./docs/development.md)** | Information for contributors on the project's architecture and setup. |
+| **[The Cookbook](./docs/examples.md)** | **(Start Here)** A collection of practical, real-world recipes to master `ZestButton`. |
+| **[Features Showcase](./docs/features.md)** | A high-level visual tour of what's possible. |
+| **[API Reference](./docs/api.md)** | An exhaustive technical reference for all props and types. |
+| **[Configuration Guide](./docs/configuration.md)**| A deep dive into global configuration using the `ZestProvider`. |
+| **[Development Guide](./docs/development.md)** | Information for contributors on the project's architecture and setup. |
 | **[Breaking Changes](./docs/breaking-changes.md)** | A log of breaking changes to assist with version upgrades. |
 
 ### License

package/dist/ZestButton.d.ts

@@ -3,6 +3,9 @@ export type ZestVariant = "standard" | "success" | "danger";
 export type ZestSize = "sm" | "md" | "lg";
 export type ZestTheme = 'light' | 'dark' | 'system';
 export type ZestButtonStyle = 'solid' | 'outline' | 'text' | 'dashed';
+export interface CustomZestSemanticTypes {
+}
+export type SemanticType = 'add' | 'save' | 'submit' | 'edit' | 'update' | 'delete' | 'remove' | 'cancel' | 'close' | 'view' | 'details' | 'download' | 'upload' | 'refresh' | 'reload' | 'print' | 'share' | 'confirm' | keyof CustomZestSemanticTypes;
 /**
  * Visual appearance of the button
  */
@@ -29,11 +32,11 @@ interface SuccessOptions {
     showFailIcon?: boolean;
     autoResetAfterMs?: number;
 }
-interface ConfirmOptions {
+export interface ConfirmOptions {
     displayLabel: string;
     timeoutSecs: number;
 }
-interface ZestCustomProps {
+export interface ZestCustomProps {
     visualOptions?: VisualOptions;
     busyOptions?: BusyOptions;
     successOptions?: SuccessOptions;
@@ -41,6 +44,7 @@ interface ZestCustomProps {
     isDefault?: boolean;
     theme?: ZestTheme;
     buttonStyle?: ZestButtonStyle;
+    semanticType?: SemanticType;
 }
 /**
  * All supported props

package/dist/ZestContext.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { ZestCustomProps } from './ZestButton';
+export interface ZestGlobalConfig {
+    defaultProps?: ZestCustomProps;
+    semanticTypeDefaults?: Partial<Record<string, Partial<ZestCustomProps>>>;
+}
+declare const ZestContext: React.Context<ZestGlobalConfig | undefined>;
+export declare const useZest: () => ZestGlobalConfig | undefined;
+export default ZestContext;

package/dist/ZestProvider.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { ZestGlobalConfig } from './ZestContext';
+interface ZestProviderProps {
+    config: ZestGlobalConfig;
+    children: React.ReactNode;
+}
+declare const ZestProvider: React.FC<ZestProviderProps>;
+export default ZestProvider;

package/dist/hooks/useBusyState.d.ts

@@ -0,0 +1,20 @@
+import { ZestCustomProps } from '../ZestButton';
+interface UseBusyStateProps {
+    busyOptions: ZestCustomProps['busyOptions'];
+    successOptions: ZestCustomProps['successOptions'];
+}
+export declare const useBusyState: ({ busyOptions, successOptions }: UseBusyStateProps) => {
+    internalBusy: boolean;
+    wasSuccessful: boolean;
+    wasFailed: boolean;
+    startBusy: () => void;
+    endBusy: (isSuccess: boolean) => void;
+    handleInternally: boolean;
+    preventRageClick: boolean;
+    minBusyDurationMs: number;
+    showCheckmark: boolean;
+    showFailIcon: boolean;
+    autoResetAfterMs: number;
+    failTimeoutRef: import("react").MutableRefObject<NodeJS.Timeout | null>;
+};
+export {};

package/dist/hooks/useConfirmation.d.ts

@@ -0,0 +1,13 @@
+import { ZestCustomProps } from '../ZestButton';
+interface UseConfirmationProps {
+    confirmOptions?: ZestCustomProps['confirmOptions'];
+    originalChildren: React.ReactNode;
+    onConfirmFail?: () => void;
+}
+export declare const useConfirmation: ({ confirmOptions, originalChildren, onConfirmFail }: UseConfirmationProps) => {
+    awaitingConfirm: boolean;
+    currentChildren: string | number | boolean | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | Iterable<import("react").ReactNode> | import("react").ReactPortal | null | undefined;
+    startConfirmation: () => void;
+    stopConfirmation: () => void;
+};
+export {};

package/dist/hooks/useThemeDetection.d.ts

@@ -0,0 +1 @@
+export declare const useThemeDetection: () => "light" | "dark";

package/dist/hooks/useZestConfig.d.ts

@@ -0,0 +1,2 @@
+import { ZestCustomProps } from '../ZestButton';
+export declare const useZestConfig: (localZestProps?: ZestCustomProps) => ZestCustomProps;