@plasmicapp/react-web 0.2.105 → 0.2.108

package/dist/all.d.ts

@@ -82,6 +82,39 @@ declare function deriveRenderOpts(props: Record<string, any>, config: {
 
 declare function ensureGlobalVariants<T extends Record<string, any>>(globalVariantValues: T): T;
 
+declare type PlasmicHeadProps = {
+    title?: string;
+    description?: string;
+    image?: string;
+    canonical?: string;
+};
+declare function PlasmicHead(props: PlasmicHeadProps): JSX.Element | null;
+declare const plasmicHeadMeta: {
+    name: string;
+    displayName: string;
+    description: string;
+    importName: string;
+    importPath: string;
+    props: {
+        title: {
+            type: string;
+            displayName: string;
+        };
+        description: {
+            type: string;
+            displayName: string;
+        };
+        image: {
+            type: string;
+            displayName: string;
+        };
+        canonical: {
+            type: string;
+            displayName: string;
+        };
+    };
+};
+
 declare function PlasmicIcon(props: React.ComponentProps<"svg"> & {
     PlasmicIconType: React.ComponentType;
 }): JSX.Element;
@@ -213,6 +246,7 @@ interface PlasmicRootProviderProps {
     platform?: "nextjs" | "gatsby";
     children?: React.ReactNode;
     translator?: PlasmicTranslator;
+    Head?: React.ComponentType<any>;
 }
 declare function PlasmicRootProvider(props: PlasmicRootProviderProps): JSX.Element;
 declare const useIsSSR: typeof useIsSSR$1;
@@ -1503,7 +1537,7 @@ interface TriggeredOverlayConfig<C extends AnyPlasmicClass> {
     contentContainer: keyof PlasmicClassOverrides<C>;
 }
 declare type TriggeredOverlayRef = React.Ref<HTMLElement>;
-declare function useTriggeredOverlay<P extends BaseTriggeredOverlayProps, C extends AnyPlasmicClass>(plasmicClass: C, props: P, config: TriggeredOverlayConfig<C>, outerRef?: TriggeredOverlayRef): {
+declare function useTriggeredOverlay<P extends BaseTriggeredOverlayProps, C extends AnyPlasmicClass>(plasmicClass: C, props: P, config: TriggeredOverlayConfig<C>, outerRef?: TriggeredOverlayRef, isDismissable?: boolean): {
     plasmicProps: {
         variants: PlasmicClassVariants<C>;
         args: PlasmicClassArgs<C>;
@@ -1559,4 +1593,4 @@ declare function generateStateOnChangeProp($state: $State, stateName: string, da
  */
 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, SelectContext, SelectOptionRef, SelectRef, SelectRefValue, SingleBooleanChoiceArg, SingleChoiceArg, Stack, StrictProps, SwitchProps, SwitchRef, SwitchRefValue, TextInputRef, TextInputRefValue, Trans, TriggeredOverlayConfig, TriggeredOverlayContext, 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 };
+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, PlasmicHead, PlasmicIcon, PlasmicImg, PlasmicLink, PlasmicRootProvider, PlasmicSlot, SelectContext, SelectOptionRef, SelectRef, SelectRefValue, SingleBooleanChoiceArg, SingleChoiceArg, Stack, StrictProps, SwitchProps, SwitchRef, SwitchRefValue, TextInputRef, TextInputRefValue, Trans, TriggeredOverlayConfig, TriggeredOverlayContext, TriggeredOverlayRef, classNames, createPlasmicElementProxy, createUseScreenVariants, deriveRenderOpts, ensureGlobalVariants, genTranslatableString, generateStateOnChangeProp, generateStateValueProp, getDataProps, hasVariant, makeFragment, omit, pick, plasmicHeadMeta, renderPlasmicSlot, setPlumeStrictMode, useButton, useCheckbox, useVanillaDollarState as useDollarState, useIsSSR, useMenu, useMenuButton, useMenuGroup, useMenuItem, useSelect, useSelectOption, useSelectOptionGroup, useSwitch, useTextInput, useTrigger, useTriggeredOverlay, wrapWithClassName };

package/dist/index-common.d.ts

@@ -3,6 +3,7 @@ export { omit, pick } from "./common";
 export { HTMLElementRefOf, StrictProps } from "./react-utils";
 export { createPlasmicElementProxy, deriveRenderOpts, Flex, hasVariant, makeFragment, MultiChoiceArg, SingleBooleanChoiceArg, SingleChoiceArg, wrapWithClassName, } from "./render/elements";
 export { ensureGlobalVariants } from "./render/global-variants";
+export { PlasmicHead, plasmicHeadMeta } from "./render/PlasmicHead";
 export { PlasmicIcon } from "./render/PlasmicIcon";
 export { PlasmicImg } from "./render/PlasmicImg";
 export { PlasmicLink } from "./render/PlasmicLink";
@@ -10,5 +11,5 @@ export { PlasmicSlot, renderPlasmicSlot } from "./render/PlasmicSlot";
 export { createUseScreenVariants } from "./render/screen-variants";
 export { PlasmicRootProvider, useIsSSR } from "./render/ssr";
 export { Stack } from "./render/Stack";
+export { genTranslatableString, Trans } from "./render/translation";
 export { useTrigger } from "./render/triggers";
-export { Trans, genTranslatableString } from "./render/translation";

package/dist/plume/triggered-overlay/triggered-overlay.d.ts

@@ -15,7 +15,7 @@ export interface TriggeredOverlayConfig<C extends AnyPlasmicClass> {
     contentContainer: keyof PlasmicClassOverrides<C>;
 }
 export declare type TriggeredOverlayRef = React.Ref<HTMLElement>;
-export declare function useTriggeredOverlay<P extends BaseTriggeredOverlayProps, C extends AnyPlasmicClass>(plasmicClass: C, props: P, config: TriggeredOverlayConfig<C>, outerRef?: TriggeredOverlayRef): {
+export declare function useTriggeredOverlay<P extends BaseTriggeredOverlayProps, C extends AnyPlasmicClass>(plasmicClass: C, props: P, config: TriggeredOverlayConfig<C>, outerRef?: TriggeredOverlayRef, isDismissable?: boolean): {
     plasmicProps: {
         variants: PlasmicClassVariants<C>;
         args: PlasmicClassArgs<C>;

package/dist/react-web.cjs.development.js

@@ -811,6 +811,83 @@ function ensureGlobalVariants(globalVariantValues) {
   return globalVariantValues;
 }
 
+var PlasmicHeadContext = /*#__PURE__*/React.createContext(undefined);
+function PlasmicHead(props) {
+  var Head = React.useContext(PlasmicHeadContext);
+
+  if (!Head) {
+    console.warn("Plasmic: Head meta tags are being ignored. To make them work, pass a Head component into PlasmicRootProvider."); // TODO: Link to doc about Head.
+
+    return null;
+  }
+
+  return React.createElement(Head, null, props.image ? React.createElement(React.Fragment, null, React.createElement("meta", {
+    name: "twitter:card",
+    content: "summary_large_image"
+  }), React.createElement("meta", {
+    key: "og:image",
+    property: "og:image",
+    content: props.image
+  }), React.createElement("meta", {
+    key: "twitter:image",
+    name: "twitter:image",
+    content: props.image
+  })) : React.createElement("meta", {
+    name: "twitter:card",
+    content: "summary"
+  }), props.title && React.createElement(React.Fragment, null, React.createElement("title", {
+    key: "title"
+  }, props.title), React.createElement("meta", {
+    key: "og:title",
+    property: "og:title",
+    content: props.title
+  }), React.createElement("meta", {
+    key: "twitter:title",
+    property: "twitter:title",
+    content: props.title
+  })), props.description && React.createElement(React.Fragment, null, React.createElement("meta", {
+    key: "description",
+    name: "description",
+    content: props.description
+  }), React.createElement("meta", {
+    key: "og:description",
+    property: "og:description",
+    content: props.description
+  }), React.createElement("meta", {
+    key: "twitter:description",
+    name: "twitter:description",
+    content: props.description
+  })), props.canonical && React.createElement("link", {
+    ref: "canonical",
+    href: props.canonical
+  }));
+}
+var plasmicHeadMeta = {
+  name: "hostless-plasmic-head",
+  displayName: "Head",
+  description: "Used to add page metadata to HEAD tag",
+  importName: "PlasmicHead",
+  importPath: "@plasmicapp/react-web",
+  props: {
+    title: {
+      type: "string",
+      displayName: "Title"
+    },
+    description: {
+      type: "string",
+      displayName: "Description"
+    },
+    image: {
+      type: "imageUrl",
+      displayName: "Image"
+    },
+    canonical: {
+      type: "string",
+      displayName: "Canonical URL"
+    }
+  }
+};
+
 function PlasmicIcon(props) {
   var PlasmicIconType = props.PlasmicIconType,
       rest = _objectWithoutPropertiesLoose(props, ["PlasmicIconType"]);
@@ -1464,7 +1541,9 @@ function PlasmicRootProvider(props) {
     value: context
   }, React.createElement(ssr.SSRProvider, null, React.createElement(PlasmicTranslatorContext.Provider, {
     value: props.translator
-  }, children)));
+  }, React.createElement(PlasmicHeadContext.Provider, {
+    value: props.Head
+  }, children))));
 }
 var useIsSSR = ssr.useIsSSR;
 function useHasPlasmicRoot() {
@@ -3001,13 +3080,17 @@ function useTextInput(plasmicClass, props, config, ref) {
   };
 }
 
-function useTriggeredOverlay(plasmicClass, props, config, outerRef) {
+function useTriggeredOverlay(plasmicClass, props, config, outerRef, isDismissable) {
   var _extends2, _overrides;
 
   if (outerRef === void 0) {
     outerRef = null;
   }
 
+  if (isDismissable === void 0) {
+    isDismissable = true;
+  }
+
   var overlayRef = React.useRef(null);
   var onOverlayRef = mergeRefs(overlayRef, outerRef);
   var context = React.useContext(TriggeredOverlayContext);
@@ -3045,7 +3128,7 @@ function useTriggeredOverlay(plasmicClass, props, config, outerRef) {
   var _useOverlay = overlays.useOverlay({
     isOpen: state.isOpen,
     onClose: state.close,
-    isDismissable: true,
+    isDismissable: isDismissable,
     shouldCloseOnBlur: true
   }, overlayRef),
       overlayAriaProps = _useOverlay.overlayProps;
@@ -3595,6 +3678,7 @@ function fillUninitializedStateValues(specs, props, stateValues, states) {
 }
 
 exports.DropdownMenu = DropdownMenu;
+exports.PlasmicHead = PlasmicHead;
 exports.PlasmicIcon = PlasmicIcon;
 exports.PlasmicImg = PlasmicImg;
 exports.PlasmicLink = PlasmicLink;
@@ -3617,6 +3701,7 @@ exports.hasVariant = hasVariant;
 exports.makeFragment = makeFragment;
 exports.omit = omit;
 exports.pick = pick;
+exports.plasmicHeadMeta = plasmicHeadMeta;
 exports.renderPlasmicSlot = renderPlasmicSlot;
 exports.setPlumeStrictMode = setPlumeStrictMode;
 exports.useButton = useButton;