@weaverse/react 0.6.29 → 0.7.1

package/dist/index.d.ts

@@ -0,0 +1,100 @@
+import * as react from 'react';
+import { ReactElement, ReactNode } from 'react';
+import { WeaverseType, Weaverse, ElementCSS, WeaverseItemStore } from '@weaverse/core';
+export * from '@weaverse/core';
+
+declare let createRootContext: (configs: WeaverseType) => Weaverse;
+declare let WeaverseContext: react.Context<Weaverse>;
+declare let WeaverseContextProvider: react.Provider<Weaverse>;
+declare let WeaverseContextConsumer: react.Consumer<Weaverse>;
+
+interface WeaverseElementProps extends ReactElement {
+    css?: ElementCSS;
+    ['data-wv-type']: string;
+    ['data-wv-id']: string;
+    children?: ReactElement | ReactElement[] | ReactNode | ReactNode[];
+}
+declare type WeaverseRootPropsType = {
+    context: Weaverse;
+};
+declare type ItemComponentProps = {
+    instance: InstanceType<typeof WeaverseItemStore>;
+};
+interface PlaceholderProps {
+    element: string;
+    children: ReactElement | ReactElement[] | ReactNode | ReactNode[];
+}
+interface ButtonElementProps extends WeaverseElementProps {
+    value: string;
+    openInNewTab: boolean;
+    target: string;
+    type: 'button' | 'submit' | 'reset';
+}
+interface ContainerElementProps extends WeaverseElementProps {
+    [key: string]: any;
+}
+interface ImageElementProps extends WeaverseElementProps {
+    src: string;
+    alt: string;
+    objectFit: 'contain' | 'cover';
+    objectPosition: 'left' | 'right' | 'top' | 'bottom' | 'center' | 'center left' | 'center right' | 'top left' | 'top right' | 'bottom left' | 'bottom right';
+    onClickAction: 'none' | 'open-lightbox' | 'open-link';
+    linkTo?: string;
+    openLinkInNewTab?: boolean;
+}
+interface LayoutElementProps extends WeaverseElementProps {
+    gridSize: number;
+    rows: number;
+    columns: number;
+    gap: number;
+    rowSize: number;
+}
+interface MapElementProps extends WeaverseElementProps {
+    place: string;
+    zoom: number;
+}
+interface TextElementProps extends WeaverseElementProps {
+    value: string;
+}
+interface VideoElementProps extends WeaverseElementProps {
+    src: string;
+    poster: string;
+    loop: boolean;
+    type: string;
+    controls: boolean;
+    autoPlay: boolean;
+    muted: boolean;
+}
+declare type CountdownTimeKey = 'days' | 'hours' | 'minutes' | 'seconds';
+interface CountdownElementProps extends WeaverseElementProps {
+    timerType: 'fixed-time' | 'evergreen';
+    startTime: number;
+    endTime: number;
+    periods: number;
+    redirectUrl: string;
+    openInNewTab: boolean;
+    showLabel: boolean;
+    showColon: boolean;
+}
+declare type TimerBlockProps = {
+    label: string;
+    value: number;
+};
+interface InstagramElementProps extends WeaverseElementProps {
+    token: string;
+    username: string;
+    numberOfImages: number;
+    imagesPerRow: number;
+    gap: number;
+}
+declare type InstagramMedia = {
+    id: string;
+    media_type: 'IMAGE' | 'CAROUSEL_ALBUM';
+    media_url: string;
+    permalink: string;
+    caption: string;
+};
+
+declare let WeaverseRoot: ({ context }: WeaverseRootPropsType) => JSX.Element | null;
+
+export { ButtonElementProps, ContainerElementProps, CountdownElementProps, CountdownTimeKey, ImageElementProps, InstagramElementProps, InstagramMedia, ItemComponentProps, LayoutElementProps, MapElementProps, PlaceholderProps, TextElementProps, TimerBlockProps, VideoElementProps, WeaverseContext, WeaverseContextConsumer, WeaverseContextProvider, WeaverseElementProps, WeaverseRoot, WeaverseRootPropsType, createRootContext };