@plasmicapp/react-web 0.2.101 → 0.2.104

package/README.md

@@ -0,0 +1,13 @@
+# @plasmicapp/react-web
+
+This is the runtime for code generated by Plasmic, the visual builder for React.
+This package contains functions
+and type definitions used by generated presentational code.
+
+Learn more about Plasmic:
+
+https://www.plasmic.app
+
+Learn more about Plasmic codegen:
+
+https://docs.plasmic.app/learn/codegen-guide/

package/dist/all.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import React__default, { FocusEvent, KeyboardEvent as KeyboardEvent$1, SyntheticEvent, ReactNode } from 'react';
+import React__default, { AriaAttributes, DOMAttributes as DOMAttributes$1, AriaRole, CSSProperties, FocusEvent, KeyboardEvent as KeyboardEvent$1, SyntheticEvent, ReactNode } from 'react';
 
 // This is the only way I found to break circular references between ClassArray and ClassValue
 // https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
@@ -268,109 +268,6 @@ declare const Stack: (<T extends "symbol" | "object" | "a" | "abbr" | "address"
     }>;
 };
 
-declare function useFocused(opts: {
-    isTextInput?: boolean;
-}): (boolean | React.HTMLAttributes<HTMLElement>)[];
-declare function useFocusVisible(opts: {
-    isTextInput?: boolean;
-}): (boolean | React.HTMLAttributes<HTMLElement>)[];
-declare function useFocusedWithin(opts: {
-    isTextInput?: boolean;
-}): (boolean | React.HTMLAttributes<HTMLElement>)[];
-declare function useFocusVisibleWithin(opts: {
-    isTextInput?: boolean;
-}): (boolean | React.HTMLAttributes<HTMLElement>)[];
-declare function useHover(): (boolean | {
-    onMouseEnter: () => void;
-    onMouseLeave: () => void;
-})[];
-declare function usePressed(): (boolean | {
-    onMouseDown: () => void;
-    onMouseUp: () => void;
-})[];
-declare const TRIGGER_TO_HOOK: {
-    readonly useHover: typeof useHover;
-    readonly useFocused: typeof useFocused;
-    readonly useFocusVisible: typeof useFocusVisible;
-    readonly useFocusedWithin: typeof useFocusedWithin;
-    readonly useFocusVisibleWithin: typeof useFocusVisibleWithin;
-    readonly usePressed: typeof usePressed;
-};
-declare type TriggerType = keyof typeof TRIGGER_TO_HOOK;
-interface TriggerOpts {
-    isTextInput?: boolean;
-}
-/**
- * Installs argment trigger. All the useTrigger calls must use hardcoded `trigger` arg,
- * as it's not valid to install variable React hooks!
- */
-declare function useTrigger(trigger: TriggerType, opts: TriggerOpts): [boolean, React.HTMLAttributes<HTMLElement>];
-
-declare const classNames: ClassNamesExport;
-
-declare function setPlumeStrictMode(mode: boolean): void;
-declare type VariantArgChoices<T> = T extends (infer M)[] ? M : T extends SingleChoiceArg<infer M> ? M : never;
-declare type VariantArgsChoices<V> = {
-    [k in keyof V]-?: VariantArgChoices<V[k]>;
-};
-declare type DictValues<V extends Record<string, any>> = V[keyof V];
-declare type DictTuples<V extends Record<string, any>> = DictValues<{
-    [K in keyof V]: [K, V[K]];
-}>;
-declare type VariantDefTuple<V> = DictTuples<VariantArgsChoices<V>>;
-declare type DistributeTuple<T> = T extends [infer T1, infer T2] ? {
-    group: T1;
-    variant: T2;
-} : never;
-declare type VariantDef<V> = DistributeTuple<VariantDefTuple<V>>;
-declare type PlasmicClass<V extends Record<string, any>, A extends Record<string, any>, O extends Record<string, any>> = {
-    (props: {
-        variants?: V;
-        args?: A;
-        overrides?: O;
-    }): React.ReactElement | null;
-    internalVariantProps: (keyof V)[];
-    internalArgProps: (keyof A)[];
-};
-declare type AnyPlasmicClass = PlasmicClass<any, any, any>;
-declare type PlasmicClassVariants<C extends AnyPlasmicClass> = C extends PlasmicClass<infer V, any, any> ? V : unknown;
-declare type PlasmicClassArgs<C extends AnyPlasmicClass> = C extends PlasmicClass<any, infer A, any> ? A : unknown;
-declare type PlasmicClassOverrides<C extends AnyPlasmicClass> = C extends PlasmicClass<any, any, infer O> ? O : unknown;
-
-interface CommonProps {
-    showStartIcon?: boolean;
-    showEndIcon?: boolean;
-    startIcon?: React.ReactNode;
-    endIcon?: React.ReactNode;
-    children?: React.ReactNode;
-    isDisabled?: boolean;
-}
-interface HtmlButtonProps extends Omit<React.ComponentProps<"button">, "ref" | "disabled"> {
-}
-interface HtmlAnchorProps extends Omit<React.ComponentProps<"a">, "ref" | "href"> {
-    link?: string;
-}
-declare type BaseButtonProps = CommonProps & HtmlButtonProps & HtmlAnchorProps;
-declare type HtmlAnchorOnlyProps = Exclude<keyof HtmlAnchorProps, keyof HtmlButtonProps>;
-declare type HtmlButtonOnlyProps = Exclude<keyof HtmlButtonProps, keyof HtmlAnchorProps>;
-declare type ButtonRef = React.Ref<HTMLButtonElement | HTMLAnchorElement>;
-interface ButtonConfig<C extends AnyPlasmicClass> {
-    showStartIconVariant: VariantDef<PlasmicClassVariants<C>>;
-    showEndIconVariant?: VariantDef<PlasmicClassVariants<C>>;
-    isDisabledVariant?: VariantDef<PlasmicClassVariants<C>>;
-    startIconSlot?: keyof PlasmicClassArgs<C>;
-    endIconSlot?: keyof PlasmicClassArgs<C>;
-    contentSlot: keyof PlasmicClassArgs<C>;
-    root: keyof PlasmicClassOverrides<C>;
-}
-declare function useButton<P extends BaseButtonProps, C extends AnyPlasmicClass>(plasmicClass: C, props: P, config: ButtonConfig<C>, ref?: ButtonRef): {
-    plasmicProps: {
-        variants: PlasmicClassVariants<C>;
-        args: PlasmicClassArgs<C>;
-        overrides: PlasmicClassOverrides<C>;
-    };
-};
-
 /*
  * Copyright 2020 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -433,6 +330,17 @@ interface FocusableDOMProps extends DOMProps {
   excludeFromTabOrder?: boolean
 }
 
+/** Any focusable element, including both HTML and SVG elements. */
+interface FocusableElement extends Element, HTMLOrSVGElement {}
+
+/** All DOM attributes supported across both HTML and SVG elements. */
+interface DOMAttributes<T = FocusableElement> extends AriaAttributes, DOMAttributes$1<T> {
+  id?: string | undefined,
+  role?: AriaRole | undefined,
+  tabIndex?: number | undefined,
+  style?: CSSProperties | undefined
+}
+
 /*
  * Copyright 2020 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -509,6 +417,109 @@ interface FocusableProps extends FocusEvents, KeyboardEvents {
   autoFocus?: boolean
 }
 
+declare function useFocused(opts: {
+    isTextInput?: boolean;
+}): (boolean | DOMAttributes<FocusableElement>)[];
+declare function useFocusVisible(opts: {
+    isTextInput?: boolean;
+}): (boolean | DOMAttributes<FocusableElement>)[];
+declare function useFocusedWithin(opts: {
+    isTextInput?: boolean;
+}): (boolean | DOMAttributes<FocusableElement>)[];
+declare function useFocusVisibleWithin(opts: {
+    isTextInput?: boolean;
+}): (boolean | DOMAttributes<FocusableElement>)[];
+declare function useHover(): (boolean | {
+    onMouseEnter: () => void;
+    onMouseLeave: () => void;
+})[];
+declare function usePressed(): (boolean | {
+    onMouseDown: () => void;
+    onMouseUp: () => void;
+})[];
+declare const TRIGGER_TO_HOOK: {
+    readonly useHover: typeof useHover;
+    readonly useFocused: typeof useFocused;
+    readonly useFocusVisible: typeof useFocusVisible;
+    readonly useFocusedWithin: typeof useFocusedWithin;
+    readonly useFocusVisibleWithin: typeof useFocusVisibleWithin;
+    readonly usePressed: typeof usePressed;
+};
+declare type TriggerType = keyof typeof TRIGGER_TO_HOOK;
+interface TriggerOpts {
+    isTextInput?: boolean;
+}
+/**
+ * Installs argment trigger. All the useTrigger calls must use hardcoded `trigger` arg,
+ * as it's not valid to install variable React hooks!
+ */
+declare function useTrigger(trigger: TriggerType, opts: TriggerOpts): [boolean, React.HTMLAttributes<HTMLElement>];
+
+declare const classNames: ClassNamesExport;
+
+declare function setPlumeStrictMode(mode: boolean): void;
+declare type VariantArgChoices<T> = T extends (infer M)[] ? M : T extends SingleChoiceArg<infer M> ? M : never;
+declare type VariantArgsChoices<V> = {
+    [k in keyof V]-?: VariantArgChoices<V[k]>;
+};
+declare type DictValues<V extends Record<string, any>> = V[keyof V];
+declare type DictTuples<V extends Record<string, any>> = DictValues<{
+    [K in keyof V]: [K, V[K]];
+}>;
+declare type VariantDefTuple<V> = DictTuples<VariantArgsChoices<V>>;
+declare type DistributeTuple<T> = T extends [infer T1, infer T2] ? {
+    group: T1;
+    variant: T2;
+} : never;
+declare type VariantDef<V> = DistributeTuple<VariantDefTuple<V>>;
+declare type PlasmicClass<V extends Record<string, any>, A extends Record<string, any>, O extends Record<string, any>> = {
+    (props: {
+        variants?: V;
+        args?: A;
+        overrides?: O;
+    }): React.ReactElement | null;
+    internalVariantProps: (keyof V)[];
+    internalArgProps: (keyof A)[];
+};
+declare type AnyPlasmicClass = PlasmicClass<any, any, any>;
+declare type PlasmicClassVariants<C extends AnyPlasmicClass> = C extends PlasmicClass<infer V, any, any> ? V : unknown;
+declare type PlasmicClassArgs<C extends AnyPlasmicClass> = C extends PlasmicClass<any, infer A, any> ? A : unknown;
+declare type PlasmicClassOverrides<C extends AnyPlasmicClass> = C extends PlasmicClass<any, any, infer O> ? O : unknown;
+
+interface CommonProps {
+    showStartIcon?: boolean;
+    showEndIcon?: boolean;
+    startIcon?: React.ReactNode;
+    endIcon?: React.ReactNode;
+    children?: React.ReactNode;
+    isDisabled?: boolean;
+}
+interface HtmlButtonProps extends Omit<React.ComponentProps<"button">, "ref" | "disabled"> {
+}
+interface HtmlAnchorProps extends Omit<React.ComponentProps<"a">, "ref" | "href"> {
+    link?: string;
+}
+declare type BaseButtonProps = CommonProps & HtmlButtonProps & HtmlAnchorProps;
+declare type HtmlAnchorOnlyProps = Exclude<keyof HtmlAnchorProps, keyof HtmlButtonProps>;
+declare type HtmlButtonOnlyProps = Exclude<keyof HtmlButtonProps, keyof HtmlAnchorProps>;
+declare type ButtonRef = React.Ref<HTMLButtonElement | HTMLAnchorElement>;
+interface ButtonConfig<C extends AnyPlasmicClass> {
+    showStartIconVariant: VariantDef<PlasmicClassVariants<C>>;
+    showEndIconVariant?: VariantDef<PlasmicClassVariants<C>>;
+    isDisabledVariant?: VariantDef<PlasmicClassVariants<C>>;
+    startIconSlot?: keyof PlasmicClassArgs<C>;
+    endIconSlot?: keyof PlasmicClassArgs<C>;
+    contentSlot: keyof PlasmicClassArgs<C>;
+    root: keyof PlasmicClassOverrides<C>;
+}
+declare function useButton<P extends BaseButtonProps, C extends AnyPlasmicClass>(plasmicClass: C, props: P, config: ButtonConfig<C>, ref?: ButtonRef): {
+    plasmicProps: {
+        variants: PlasmicClassVariants<C>;
+        args: PlasmicClassArgs<C>;
+        overrides: PlasmicClassOverrides<C>;
+    };
+};
+
 /*
  * Copyright 2020 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -1182,4 +1193,28 @@ declare function useTriggeredOverlay<P extends BaseTriggeredOverlayProps, C exte
     };
 };
 
-export { BaseButtonProps, BaseMenuButtonProps, BaseMenuGroupProps, BaseMenuItemProps, BaseMenuProps, BaseSelectOptionGroupProps, BaseSelectOptionProps, BaseSelectProps, BaseTextInputProps, BaseTriggeredOverlayProps, ButtonRef, CheckboxProps, CheckboxRef, CheckboxRefValue, DropdownMenu, Flex, HTMLElementRefOf, HtmlAnchorOnlyProps, HtmlButtonOnlyProps, MenuButtonRef, MenuButtonRefValue, MenuRef, MenuRefValue, MultiChoiceArg, PlasmicIcon, PlasmicImg, PlasmicLink, PlasmicRootProvider, PlasmicSlot, SelectOptionRef, SelectRef, SelectRefValue, SingleBooleanChoiceArg, SingleChoiceArg, Stack, StrictProps, SwitchProps, SwitchRef, SwitchRefValue, TextInputRef, TextInputRefValue, Trans, TriggeredOverlayConfig, TriggeredOverlayRef, classNames, createPlasmicElementProxy, createUseScreenVariants, deriveRenderOpts, ensureGlobalVariants, genTranslatableString, getDataProps, hasVariant, makeFragment, omit, pick, renderPlasmicSlot, setPlumeStrictMode, useButton, useCheckbox, useIsSSR, useMenu, useMenuButton, useMenuGroup, useMenuItem, useSelect, useSelectOption, useSelectOptionGroup, useSwitch, useTextInput, useTrigger, useTriggeredOverlay, wrapWithClassName };
+declare type InitFunc<T> = ($props: Record<string, any>, $state: $State) => T;
+interface $State {
+    [key: string]: any;
+    registerInitFunc: (path: string, f: InitFunc<any>) => any;
+}
+interface $StateSpec<T> {
+    path: string;
+    initFunc?: InitFunc<T>;
+    initVal?: T;
+    type: "private" | "readonly" | "writable";
+    valueProp?: string;
+    onChangeProp?: string;
+}
+declare function useVanillaDollarState(_specs: $StateSpec<any>[], props: Record<string, any>): $State;
+
+declare function generateStateOnChangeProp($state: $State, stateName: string, dataReps: number[]): (val: any, path: (string | number)[]) => void;
+/**
+ * This function generate the state value prop for repeated states
+ * Example:
+ *   - parent[][].counter[].count
+ * We need to pass `parent[index1][index2].counter to the child component
+ */
+declare function generateStateValueProp($state: $State, path: (string | number)[]): any;
+
+export { BaseButtonProps, BaseMenuButtonProps, BaseMenuGroupProps, BaseMenuItemProps, BaseMenuProps, BaseSelectOptionGroupProps, BaseSelectOptionProps, BaseSelectProps, BaseTextInputProps, BaseTriggeredOverlayProps, ButtonRef, CheckboxProps, CheckboxRef, CheckboxRefValue, DropdownMenu, Flex, HTMLElementRefOf, HtmlAnchorOnlyProps, HtmlButtonOnlyProps, MenuButtonRef, MenuButtonRefValue, MenuRef, MenuRefValue, MultiChoiceArg, PlasmicIcon, PlasmicImg, PlasmicLink, PlasmicRootProvider, PlasmicSlot, SelectOptionRef, SelectRef, SelectRefValue, SingleBooleanChoiceArg, SingleChoiceArg, Stack, StrictProps, SwitchProps, SwitchRef, SwitchRefValue, TextInputRef, TextInputRefValue, Trans, TriggeredOverlayConfig, TriggeredOverlayRef, classNames, createPlasmicElementProxy, createUseScreenVariants, deriveRenderOpts, ensureGlobalVariants, genTranslatableString, generateStateOnChangeProp, generateStateValueProp, getDataProps, hasVariant, makeFragment, omit, pick, renderPlasmicSlot, setPlumeStrictMode, useButton, useCheckbox, useVanillaDollarState as useDollarState, useIsSSR, useMenu, useMenuButton, useMenuGroup, useMenuItem, useSelect, useSelectOption, useSelectOptionGroup, useSwitch, useTextInput, useTrigger, useTriggeredOverlay, wrapWithClassName };

package/dist/index.d.ts

@@ -9,3 +9,5 @@ export * from "./plume/select";
 export * from "./plume/switch";
 export * from "./plume/text-input";
 export * from "./plume/triggered-overlay";
+export * from "./states/helpers";
+export { default as useDollarState } from "./states/index";

package/dist/plume/menu-button/menu-trigger.d.ts

@@ -15,7 +15,7 @@ export declare function useMenuTrigger(opts: {
     menuWidth?: number;
     menu: React.ReactElement<BaseMenuProps> | (() => React.ReactElement<BaseMenuProps>);
 }, state: MenuTriggerState): {
-    triggerProps: React.HTMLAttributes<HTMLElement>;
+    triggerProps: import("@react-types/shared").DOMAttributes<import("@react-types/shared").FocusableElement>;
     makeMenu: () => React.ReactElement<BaseMenuProps, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)> | null;
     triggerContext: TriggeredOverlayContextValue;
 };