@qtalo/qt-ui-library 0.1.19 → 0.1.21
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/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +18 -2
- package/dist/index.js +311 -239
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1234,7 +1234,10 @@ export declare function NotFireIcon({ pathProps, ...props }: IconProps): JSX.Ele
|
|
|
1234
1234
|
* OnboardingEngine + measured OnboardingCard portaled to `document.body`.
|
|
1235
1235
|
* Step visibility and order come from `steps` and `context`.
|
|
1236
1236
|
*/
|
|
1237
|
-
export declare function Onboarding<TContext>({ steps, context, onFinish, }: OnboardingProps<TContext>): JSX.Element;
|
|
1237
|
+
export declare function Onboarding<TContext>({ steps, context, storageKey, onFinish, isEnabled, }: OnboardingProps<TContext>): JSX.Element;
|
|
1238
|
+
|
|
1239
|
+
/** localStorage key for dismissed step ids (JSON string array). */
|
|
1240
|
+
export declare const ONBOARDING_DISMISSED_STORAGE_KEY = "onboarding_dismissed";
|
|
1238
1241
|
|
|
1239
1242
|
/**
|
|
1240
1243
|
* Presentational onboarding callout: purple card, arrow, and optional actions.
|
|
@@ -1271,7 +1274,7 @@ export declare type OnboardingCardProps = {
|
|
|
1271
1274
|
* `isVisible(context)` is the active one. Dismissing does not advance until the
|
|
1272
1275
|
* next step’s predicate becomes true.
|
|
1273
1276
|
*/
|
|
1274
|
-
export declare function OnboardingEngine<TContext, TStep extends OnboardingEngineStep<TContext>>({ steps, context, children }: OnboardingEngineProps<TContext, TStep>): JSX.Element;
|
|
1277
|
+
export declare function OnboardingEngine<TContext, TStep extends OnboardingEngineStep<TContext>>({ steps, context, storageKey, isEnabled, children, }: OnboardingEngineProps<TContext, TStep>): JSX.Element;
|
|
1275
1278
|
|
|
1276
1279
|
export declare type OnboardingEngineActions = {
|
|
1277
1280
|
dismissCurrentStep: () => void;
|
|
@@ -1294,6 +1297,9 @@ export declare type OnboardingEngineChildProps<TContext, TStep extends Onboardin
|
|
|
1294
1297
|
export declare type OnboardingEngineProps<TContext, TStep extends OnboardingEngineStep<TContext>> = {
|
|
1295
1298
|
steps: readonly TStep[];
|
|
1296
1299
|
context: TContext;
|
|
1300
|
+
storageKey?: string;
|
|
1301
|
+
/** When `false`, no step is active and resolution is skipped. @default true */
|
|
1302
|
+
isEnabled?: boolean;
|
|
1297
1303
|
children: (props: OnboardingEngineChildProps<TContext, TStep>) => ReactNode;
|
|
1298
1304
|
};
|
|
1299
1305
|
|
|
@@ -1334,7 +1340,11 @@ export declare type OnboardingProps<TContext = unknown> = {
|
|
|
1334
1340
|
*/
|
|
1335
1341
|
steps: readonly OnboardingPatternStep<TContext>[];
|
|
1336
1342
|
context: TContext;
|
|
1343
|
+
/** Passed through to `OnboardingEngine` for user-scoped dismissal persistence. */
|
|
1344
|
+
storageKey?: string;
|
|
1337
1345
|
onFinish?: () => void;
|
|
1346
|
+
/** When `false`, no callout is shown. @default true */
|
|
1347
|
+
isEnabled?: boolean;
|
|
1338
1348
|
};
|
|
1339
1349
|
|
|
1340
1350
|
export declare function OutlookCalendarIcon(props: IconProps): JSX.Element;
|
|
@@ -1361,12 +1371,18 @@ declare type PressableProps<T extends ElementType = "div"> = PressableOwnProps &
|
|
|
1361
1371
|
as?: T;
|
|
1362
1372
|
} & Omit<ComponentPropsWithoutRef<T>, keyof PressableOwnProps | "as">;
|
|
1363
1373
|
|
|
1374
|
+
export declare function QtaloBlueImage({ size, className, ...props }: QtaloImageProps_2): JSX.Element;
|
|
1375
|
+
|
|
1364
1376
|
export declare function QtaloImage({ size, className, ...props }: QtaloImageProps): JSX.Element;
|
|
1365
1377
|
|
|
1366
1378
|
declare type QtaloImageProps = SVGProps<SVGSVGElement> & {
|
|
1367
1379
|
size?: number;
|
|
1368
1380
|
};
|
|
1369
1381
|
|
|
1382
|
+
declare type QtaloImageProps_2 = SVGProps<SVGSVGElement> & {
|
|
1383
|
+
size?: number;
|
|
1384
|
+
};
|
|
1385
|
+
|
|
1370
1386
|
export declare function ReadIcon({ pathProps, ...props }: IconProps): JSX.Element;
|
|
1371
1387
|
|
|
1372
1388
|
export declare function RichContent({ content, className }: RichContentProps): JSX.Element;
|