@contember/react-block-repeater 2.0.0-alpha.4 → 2.0.0-alpha.40

package/dist/types/components/BlockRepeaterAddItemTrigger.d.ts

@@ -1,11 +1,43 @@
 import { ReactElement } from 'react';
 import { EntityAccessor } from '@contember/react-binding';
 import { RepeaterAddItemIndex } from '@contember/react-repeater';
+/**
+ * Props for the {@link BlockRepeaterAddItemTrigger} component.
+ */
 export interface BlockRepeaterAddItemTriggerProps {
-    children: ReactElement;
+    /**
+     * The type of the item to add.
+     */
     type: string;
+    /**
+     * The index at which to add the item.
+     * Can be one of:
+     *  - number: Adds the item at the specified index.
+     *  - `'first'`: Adds the item at the beginning.
+     *  - undefined or `'last'`: Adds the item at the end.
+     */
     index?: RepeaterAddItemIndex;
+    /**
+     * A function to preprocess the entity.
+     */
     preprocess?: EntityAccessor.BatchUpdatesHandler;
+    /**
+     * The button element.
+     */
+    children: ReactElement;
 }
+/**
+ * A trigger component for adding item of given type to a block repeater.
+ *
+ * ## Props {@link BlockRepeaterAddItemTriggerProps}
+ * - type, ?index, ?preprocess, children
+ *
+ * ## Example
+ * ```tsx
+ * <BlockRepeaterAddItemTrigger type="image" index="first">
+ *     <button>Add Image</button>
+ * </BlockRepeaterAddItemTrigger>
+ * ```
+ */
 export declare const BlockRepeaterAddItemTrigger: ({ preprocess, index, type, ...props }: BlockRepeaterAddItemTriggerProps) => import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=BlockRepeaterAddItemTrigger.d.ts.map

package/dist/types/components/BlockRepeaterAddItemTrigger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlockRepeaterAddItemTrigger.d.ts","sourceRoot":"","sources":["../../../src/components/BlockRepeaterAddItemTrigger.tsx"],"names":[],"mappings":"AAEA,OAAc,EAAE,YAAY,EAAW,MAAM,OAAO,CAAA;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,EAAE,oBAAoB,EAAsB,MAAM,2BAA2B,CAAA;AAEpF,MAAM,WAAW,gCAAgC;IAChD,QAAQ,EAAE,YAAY,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,oBAAoB,CAAA;IAC5B,UAAU,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAA;CAC/C;AAED,eAAO,MAAM,2BAA2B,0CAA2C,gCAAgC,4CASlH,CAAA"}
+{"version":3,"file":"BlockRepeaterAddItemTrigger.d.ts","sourceRoot":"","sources":["../../../src/components/BlockRepeaterAddItemTrigger.tsx"],"names":[],"mappings":"AAEA,OAAc,EAAE,YAAY,EAAwB,MAAM,OAAO,CAAA;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,EAAE,oBAAoB,EAAsB,MAAM,2BAA2B,CAAA;AAMpF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAEhD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAA;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAA;IAE/C;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAA;CACtB;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,2BAA2B,0CAA2C,gCAAgC,4CAYlH,CAAA"}

package/dist/types/contexts.d.ts

@@ -2,11 +2,14 @@ import { SugaredRelativeSingleField } from '@contember/react-binding';
 import { BlocksMap } from './types';
 /** @internal */
 export declare const BlockRepeaterConfigContext: import("react").Context<{
-    discriminatedBy: SugaredRelativeSingleField['field'];
+    discriminatedBy: SugaredRelativeSingleField["field"];
     blocks: BlocksMap;
 }>;
+/**
+ * Returns configuration of the block repeater (discrimination field and blocks map).
+ */
 export declare const useBlockRepeaterConfig: () => {
-    discriminatedBy: SugaredRelativeSingleField['field'];
+    discriminatedBy: SugaredRelativeSingleField["field"];
     blocks: BlocksMap;
 };
 //# sourceMappingURL=contexts.d.ts.map

package/dist/types/contexts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contexts.d.ts","sourceRoot":"","sources":["../../src/contexts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAA;AAErE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAMnC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B;qBAJrB,0BAA0B,CAAC,OAAO,CAAC;YAC5C,SAAS;EAGsD,CAAA;AACxE,eAAO,MAAM,sBAAsB;qBALjB,0BAA0B,CAAC,OAAO,CAAC;YAC5C,SAAS;CAIkD,CAAA"}
+{"version":3,"file":"contexts.d.ts","sourceRoot":"","sources":["../../src/contexts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAA;AAErE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAMnC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B;qBAJrB,0BAA0B,CAAC,OAAO,CAAC;YAC5C,SAAS;EAGsD,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,sBAAsB;qBATjB,0BAA0B,CAAC,OAAO,CAAC;YAC5C,SAAS;CAQkD,CAAA"}

package/dist/types/hooks/useBlockRepeaterCurrentBlock.d.ts

@@ -1,2 +1,6 @@
-export declare const useBlockRepeaterCurrentBlock: () => import("..").BlockProps | undefined;
+import { BlockProps } from '../components';
+/**
+ * Returns the current block props (see {@link BlockProps}).
+ */
+export declare const useBlockRepeaterCurrentBlock: () => BlockProps | undefined;
 //# sourceMappingURL=useBlockRepeaterCurrentBlock.d.ts.map

package/dist/types/hooks/useBlockRepeaterCurrentBlock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useBlockRepeaterCurrentBlock.d.ts","sourceRoot":"","sources":["../../../src/hooks/useBlockRepeaterCurrentBlock.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,4BAA4B,2CAKxC,CAAA"}
+{"version":3,"file":"useBlockRepeaterCurrentBlock.d.ts","sourceRoot":"","sources":["../../../src/hooks/useBlockRepeaterCurrentBlock.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAO,UAAU,GAAG,SAK5D,CAAA"}