@airtable/blocks 0.0.0-experimental-20e3506bd-20250428 → 0.0.0-experimental-d5ee5e823-20250501

package/dist/types/src/base/models/record_coloring.d.ts

@@ -54,8 +54,8 @@ export declare const serialize: (mode: RecordColorMode) => string;
  * @alias recordColoring.modes
  * @example
  * ```js
- * import {recordColoring} from '@airtable/blocks/models';
- * import {useRecords} from '@airtable/blocks/ui';
+ * import {recordColoring} from '@airtable/blocks/base/models';
+ * import {useRecords} from '@airtable/blocks/base/ui';
  *
  * // no record coloring:
  * const recordColorMode = recordColoring.modes.none();

package/dist/types/src/base/models/record_query_result.d.ts

@@ -108,7 +108,7 @@ export interface ViewMetadataForUpdate {
  * supported record color modes: none, by a view, and by a select field.
  *
  * ```js
- * import {recordColoring} from '@airtable/blocks/models';
+ * import {recordColoring} from '@airtable/blocks/base/models';
  * // No record coloring:
  * const opts = {
  *     recordColorMode: recordColoring.modes.none(),

package/dist/types/src/base/models/session.d.ts

@@ -6,7 +6,7 @@ import { PermissionCheckResult } from '../../shared/types/mutations_core';
  *
  * @example
  * ```js
- * import {useSession} from '@airtable/blocks/ui';
+ * import {useSession} from '@airtable/blocks/base/ui';
  *
  * function Username() {
  *     const session = useSession();
@@ -31,7 +31,7 @@ declare class Session extends SessionCore<BaseSdkMode> {
      *
      * @example
      * ```js
-     * import {useSession} from '@airtable/blocks/ui';
+     * import {useSession} from '@airtable/blocks/base/ui';
      *
      * function UpdateButton({onClick}) {
      *     const session = useSession();
@@ -64,7 +64,7 @@ declare class Session extends SessionCore<BaseSdkMode> {
      *
      * @example
      * ```js
-     * import {useSession} from '@airtable/blocks/ui';
+     * import {useSession} from '@airtable/blocks/base/ui';
      *
      * function CreateButton({onClick}) {
      *     const session = useSession();
@@ -97,7 +97,7 @@ declare class Session extends SessionCore<BaseSdkMode> {
      *
      * @example
      * ```js
-     * import {useSession} from '@airtable/blocks/ui';
+     * import {useSession} from '@airtable/blocks/base/ui';
      *
      * function DeleteButton({onClick}) {
      *     const session = useSession();

package/dist/types/src/base/models/table.d.ts

@@ -146,7 +146,7 @@ declare class Table extends TableCore<BaseSdkMode, WatchableTableKey> {
      * @param opts Options for the query, such as sorts and fields.
      * @example
      * ```js
-     * import {useBase, useRecords} from '@airtable/blocks/ui';
+     * import {useBase, useRecords} from '@airtable/blocks/base/ui';
      * import React from 'react';
      *
      * function TodoList() {
@@ -200,7 +200,7 @@ declare class Table extends TableCore<BaseSdkMode, WatchableTableKey> {
      * correct type, that view will be returned before checking the other views in the table.
      * @example
      * ```js
-     * import {ViewType} from '@airtable/blocks/models';
+     * import {ViewType} from '@airtable/blocks/base/models';
      * const firstCalendarView = myTable.getFirstViewOfType(ViewType.CALENDAR);
      * if (firstCalendarView !== null) {
      *     console.log(firstCalendarView.name);

package/dist/types/src/base/models/view.d.ts

@@ -73,7 +73,7 @@ declare class View extends AbstractModel<BaseSdkMode, ViewData, WatchableViewKey
      * default, records will be coloured according to the view.
      * @example
      * ```js
-     * import {useBase, useRecords} from '@airtable/blocks/UI';
+     * import {useBase, useRecords} from '@airtable/blocks/base/ui';
      * import React from 'react';
      *
      * function TodoList() {

package/dist/types/src/base/perform_record_action.d.ts

@@ -36,7 +36,7 @@ type UnsubscribeFunction = () => void;
  * @example
  * ```js
  * import React, {useEffect, useState} from 'react';
- * import {registerRecordActionDataCallback} from '@airtable/blocks/ui';
+ * import {registerRecordActionDataCallback} from '@airtable/blocks/base/ui';
  *
  * function LatestRecordAction() {
  *     const [recordActionData, setRecordActionData] = useState(null);

package/dist/types/src/base/sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../../src/base/sdk.ts"],"names":[],"mappings":"AAAA,cAAc,CAAC,MAAM;AAarB,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAIlC,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAC/C,OAAO,QAAQ,MAAM,aAAa,CAAC;AAEnC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,6BAA6B,CAAC;AActE;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY,CAAC,WAAW,CAAC;IAC/D;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B,cAAc;IACd,QAAQ,EAAE,QAAQ,CAAC;IAoBnB,cAAc;gBACF,iBAAiB,EAAE,iBAAiB;IAsGhD,cAAc;IACR,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAI1E,cAAc;IACd,kBAAkB,IAAI,eAAe;CAGxC"}
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../../src/base/sdk.ts"],"names":[],"mappings":"AAAA,cAAc,CAAC,MAAM;AAarB,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAIlC,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAC/C,OAAO,QAAQ,MAAM,aAAa,CAAC;AAEnC,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,6BAA6B,CAAC;AActE;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY,CAAC,WAAW,CAAC;IAC/D;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B,cAAc;IACd,QAAQ,EAAE,QAAQ,CAAC;IAuBnB,cAAc;gBACF,iBAAiB,EAAE,iBAAiB;IAsGhD,cAAc;IACR,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAI1E,cAAc;IACd,kBAAkB,IAAI,eAAe;CAGxC"}

package/dist/types/src/base/settings_button.d.ts

@@ -21,8 +21,8 @@ type WatchableSettingsButtonKey = ObjectValues<typeof WatchableSettingsButtonKey
  * @alias settingsButton
  * @example
  * ```js
- * import {settingsButton} from '@airtable/blocks';
- * import {useWatchable} from '@airtable/blocks/ui';
+ * import {settingsButton} from '@airtable/blocks/base';
+ * import {useWatchable} from '@airtable/blocks/base/ui';
  *
  * function AppWithSettings({shouldShowSettingsButton}) {
  *     useEffect(() => {

package/dist/types/src/base/types/view.d.ts

@@ -7,7 +7,7 @@ import { FieldId, RecordId, ViewId } from '../../shared/types/hyper_ids';
  *
  * @example
  * ```js
- * import {ViewType} from '@airtable/blocks/models';
+ * import {ViewType} from '@airtable/blocks/base/models';
  * const gridViews = myTable.views.filter(view => (
  *     view.type === ViewType.GRID
  * ));

package/dist/types/src/base/ui/base_provider.d.ts

@@ -19,7 +19,7 @@ interface BaseProviderProps {
  * ```js
  * import React from 'react';
  * import ReactDOM from 'react-dom';
- * import {BaseProvider} from '@airtable/blocks/ui';
+ * import {BaseProvider} from '@airtable/blocks/base/ui';
  *
  * function getHtmlStringForRecordCard(base, record) {
  *     return ReactDOM.renderToStaticMarkup(

package/dist/types/src/base/ui/expand_record.d.ts

@@ -15,7 +15,7 @@ export interface ExpandRecordOpts {
  *
  * @example
  * ```js
- * import {expandRecord} from '@airtable/blocks/ui';
+ * import {expandRecord} from '@airtable/blocks/base/ui';
  * expandRecord(record1, {
  *     records: [record1, record2, record3],
  * });

package/dist/types/src/base/ui/expand_record_list.d.ts

@@ -15,7 +15,7 @@ interface ExpandRecordListOpts {
  *
  * @example
  * ```js
- * import {expandRecordList} from '@airtable/blocks/ui';
+ * import {expandRecordList} from '@airtable/blocks/base/ui';
  * expandRecordList([record1, record2, record3]);
  *
  * expandRecordList([record1, record2], {

package/dist/types/src/base/ui/expand_record_picker_async.d.ts

@@ -23,7 +23,7 @@ interface ExpandRecordPickerOpts {
  * @param opts An optional options object.
  * @example
  * ```js
- * import {expandRecordPickerAsync} from '@airtable/blocks/ui';
+ * import {expandRecordPickerAsync} from '@airtable/blocks/base/ui';
  *
  * async function pickRecordsAsync() {
  *     const recordA = await expandRecordPickerAsync([record1, record2, record3]);

package/dist/types/src/base/ui/global_alert.d.ts

@@ -9,7 +9,7 @@ type WatchableGlobalAlertKey = ObjectValues<typeof WatchableGlobalAlertKeys>;
  * @hidden
  * @example
  * ```js
- * import {globalAlert} from '@airtable/blocks/ui';
+ * import {globalAlert} from '@airtable/blocks/base/ui';
  * globalAlert.showReloadPrompt();
  * ```
  */

package/dist/types/src/base/ui/initialize_block.d.ts

@@ -24,7 +24,7 @@ type DashboardOrEntryPoints = DashboardEntryElementFunction | EntryPoints;
  *
  * @example
  * ```js
- * import {initializeBlock} from '@airtable/blocks/ui';
+ * import {initializeBlock} from '@airtable/blocks/base/ui';
  * import React from 'react';
  *
  * function App() {

package/dist/types/src/base/ui/initialize_block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initialize_block.d.ts","sourceRoot":"","sources":["../../../../../src/base/ui/initialize_block.tsx"],"names":[],"mappings":"AAAA,mDAAmD,CAAC,MAAM;AAC1D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,GAAG,MAAM,QAAQ,CAAC;AAGzB,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAKlC,MAAM;AACN,KAAK,6BAA6B,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC;AAC3D,cAAc;AACd,KAAK,wBAAwB,GAAG,CAAC,EAAC,KAAK,EAAE,IAAI,EAAC,EAAE;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,KAAK,KAAK,CAAC,SAAS,CAAC;AAC/F,cAAc;AACd,UAAU,WAAW;IACjB,SAAS,CAAC,EAAE,6BAA6B,CAAC;IAC1C,IAAI,CAAC,EAAE,wBAAwB,CAAC;CACnC;AAED,cAAc;AACd,KAAK,sBAAsB,GAAG,6BAA6B,GAAG,WAAW,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAAC,eAAe,EAAE,sBAAsB,QAoEtE;AAMD,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,GAAG,QAEvD;AAGD,wBAAgB,yBAAyB,SAExC"}
+{"version":3,"file":"initialize_block.d.ts","sourceRoot":"","sources":["../../../../../src/base/ui/initialize_block.tsx"],"names":[],"mappings":"AAAA,mDAAmD,CAAC,MAAM;AAC1D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,GAAG,MAAM,QAAQ,CAAC;AAGzB,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAKlC,MAAM;AACN,KAAK,6BAA6B,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC;AAC3D,cAAc;AACd,KAAK,wBAAwB,GAAG,CAAC,EAAC,KAAK,EAAE,IAAI,EAAC,EAAE;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,KAAK,KAAK,CAAC,SAAS,CAAC;AAC/F,cAAc;AACd,UAAU,WAAW;IACjB,SAAS,CAAC,EAAE,6BAA6B,CAAC;IAC1C,IAAI,CAAC,EAAE,wBAAwB,CAAC;CACnC;AAED,cAAc;AACd,KAAK,sBAAsB,GAAG,6BAA6B,GAAG,WAAW,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAAC,eAAe,EAAE,sBAAsB,QA8EtE;AAMD,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,GAAG,QAEvD;AAGD,wBAAgB,yBAAyB,SAExC"}

package/dist/types/src/base/ui/progress_bar.d.ts

@@ -46,7 +46,7 @@ export interface ProgressBarProps extends ProgressBarStyleProps, TooltipAnchorPr
  *
  * @example
  * ```js
- * import {ProgressBar} from '@airtable/blocks/ui';
+ * import {ProgressBar} from '@airtable/blocks/base/ui';
  *
  * function MyComponent() {
  *     return (

package/dist/types/src/base/ui/types/tooltip_anchor_props.d.ts

@@ -1,3 +1,4 @@
+import React from 'react';
 import PropTypes from 'prop-types';
 /** @hidden */
 export interface TooltipAnchorProps<T = HTMLElement> {

package/dist/types/src/base/ui/types/tooltip_anchor_props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tooltip_anchor_props.d.ts","sourceRoot":"","sources":["../../../../../../src/base/ui/types/tooltip_anchor_props.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AAGnC,cAAc;AACd,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,WAAW;IAC/C,cAAc;IACd,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IACnD,cAAc;IACd,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAKnD,cAAc;IACd,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAC9C,cAAc;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,sBAAsB;;;;;CAKlC,CAAC"}
+{"version":3,"file":"tooltip_anchor_props.d.ts","sourceRoot":"","sources":["../../../../../../src/base/ui/types/tooltip_anchor_props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAGnC,cAAc;AACd,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,WAAW;IAC/C,cAAc;IACd,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IACnD,cAAc;IACd,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAKnD,cAAc;IACd,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAC9C,cAAc;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,eAAO,MAAM,sBAAsB;;;;;CAKlC,CAAC"}

package/dist/types/src/base/ui/ui.d.ts

@@ -28,7 +28,7 @@ export { default as SwitchSynced } from './switch_synced';
 export { default as ViewportConstraint } from './viewport_constraint';
 export { initializeBlock } from './initialize_block';
 export { default as withHooks } from '../../shared/ui/with_hooks';
-export { default as useLoadable } from '../../shared/ui/use_loadable';
+export { default as useLoadable } from './use_loadable';
 export { useRecordIds, useRecords, useRecordById, useRecordQueryResult } from './use_records';
 export { default as useBase } from './use_base';
 export { default as useCursor } from './use_cursor';

package/dist/types/src/base/ui/ui.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../../../src/base/ui/ui.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAMzC,OAAO,IAAI,CAAC;AAEZ,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAC,OAAO,IAAI,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,mBAAmB,EAAC,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAC,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,oBAAoB,EAAC,MAAM,eAAe,CAAC;AAC5F,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAC,gCAAgC,EAAC,MAAM,0BAA0B,CAAC;AAE1E,cAAc,0BAA0B,CAAC;AAEzC,eAAO,MAAM,WAAW,aAAoB,CAAC"}
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../../../src/base/ui/ui.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAMzC,OAAO,IAAI,CAAC;AAEZ,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAC,OAAO,IAAI,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,mBAAmB,EAAC,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,oBAAoB,EAAC,MAAM,eAAe,CAAC;AAC5F,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AACpD,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAC,gCAAgC,EAAC,MAAM,0BAA0B,CAAC;AAE1E,cAAc,0BAA0B,CAAC;AAEzC,eAAO,MAAM,WAAW,aAAoB,CAAC"}

package/dist/types/src/base/ui/use_base.d.ts

@@ -12,7 +12,7 @@
  *
  * @example
  * ```js
- * import {useBase} from '@airtable/blocks/ui';
+ * import {useBase} from '@airtable/blocks/base/ui';
  *
  * // renders a list of tables and automatically updates
  * function TableList() {

package/dist/types/src/base/ui/use_cursor.d.ts

@@ -13,7 +13,7 @@ import Cursor from '../models/cursor';
  *
  * @example
  * ```js
- * import {useBase, useCursor} from '@airtable/blocks/ui';
+ * import {useBase, useCursor} from '@airtable/blocks/base/ui';
  *
  * // renders a list of tables and automatically updates
  * function TableList() {

package/dist/types/src/{shared → base}/ui/use_loadable.d.ts

@@ -48,7 +48,7 @@ interface UseLoadableOpts {
  *
  * @example
  * ```js
- * import {useCursor, useLoadable, useWatchable} from '@airtable/blocks/ui';
+ * import {useCursor, useLoadable, useWatchable} from '@airtable/blocks/base/ui';
  *
  *  function SelectedRecordIds() {
  *      const cursor = useCursor();
@@ -65,7 +65,7 @@ interface UseLoadableOpts {
  *
  * @example
  * ```js
- *  import {useLoadable} from '@airtable/blocks/ui';
+ *  import {useLoadable} from '@airtable/blocks/base/ui';
  *
  *  function LoadTwoQueryResults({queryResultA, queryResultB}) {
  *      // load the queryResults:
@@ -78,7 +78,7 @@ interface UseLoadableOpts {
  *
  * @example
  * ```js
- *  import {useLoadable, useBase} from '@airtable/blocks/ui';
+ *  import {useLoadable, useBase} from '@airtable/blocks/base/ui';
  *
  *  function LoadAllRecords() {
  *      const base = useBase();

package/dist/types/src/base/ui/use_loadable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use_loadable.d.ts","sourceRoot":"","sources":["../../../../../src/base/ui/use_loadable.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,UAAU,aAAa;IACnB,cAAc;IACd,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,cAAc;IACd,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,cAAc;IACd,UAAU,IAAI,IAAI,CAAC;IACnB,cAAc;IACd,KAAK,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5E,cAAc;IACd,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;CACjF;AAID;;GAEG;AACH,UAAU,eAAe;IACrB,gKAAgK;IAChK,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAC/B,MAAM,EAAE,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,aAAa,GAAG,IAAI,EAClE,IAAI,GAAE,eAAuC,QAiFhD"}

package/dist/types/src/base/ui/use_record_action_data.d.ts

@@ -28,7 +28,7 @@ import { RecordActionData } from '../types/record_action_data';
  * @example
  * ```js
  * import React from 'react';
- * import {useRecordActionData} from '@airtable/blocks/ui';
+ * import {useRecordActionData} from '@airtable/blocks/base/ui';
  *
  * function LatestRecordAction() {
  *     const recordActionData = useRecordActionData();

package/dist/types/src/base/ui/use_session.d.ts

@@ -9,7 +9,7 @@
  *
  * @example
  * ```js
- * import {CollaboratorToken, useSession} from '@airtable/blocks/ui';
+ * import {CollaboratorToken, useSession} from '@airtable/blocks/base/ui';
  *
  * // Says hello to the current user and updates in realtime if the current user's
  * // name or profile pic changes.

package/dist/types/src/base/ui/use_settings_button.d.ts

@@ -8,7 +8,7 @@ import { FlowAnyFunction } from '../../shared/private_utils';
  *
  * @example
  * ```js
- * import {useSettingsButton} from '@airtable/blocks/ui';
+ * import {useSettingsButton} from '@airtable/blocks/base/ui';
  * import {useState} from 'react';
  *
  * function ComponentWithSettings() {

package/dist/types/src/base/ui/use_viewport.d.ts

@@ -6,7 +6,7 @@ import Viewport from '../viewport';
  *
  * @example
  * ```js
- * import {useViewport} from '@airtable/blocks/ui';
+ * import {useViewport} from '@airtable/blocks/base/ui';
  *
  * function ViewportSize() {
  *      const viewport = useViewport();

package/dist/types/src/base/ui/viewport_constraint.d.ts

@@ -27,13 +27,13 @@ interface ViewportConstraintProps {
  *
  * @example
  * ```js
- * import {ViewportConstraint} from '@airtable/blocks/ui';
+ * import {ViewportConstraint} from '@airtable/blocks/base/ui';
  * <ViewportConstraint minSize={{width: 400}} />
  * ```
  *
  * @example
  * ```js
- * import {ViewportConstraint} from '@airtable/blocks/ui';
+ * import {ViewportConstraint} from '@airtable/blocks/base/ui';
  * <ViewportConstraint maxFullScreenSize={{width: 600, height: 400}}>
  *      <div>I need a max fullscreen size!</div>
  * </ViewportConstraint>

package/dist/types/src/base/viewport.d.ts

@@ -26,7 +26,7 @@ type UnsetFn = () => void;
  *
  * @example
  * ```js
- * import {viewport} from '@airtable/blocks';
+ * import {viewport} from '@airtable/blocks/base';
  * ```
  * @docsPath models/Viewport
  */

package/dist/types/src/interface/models/models.d.ts

@@ -0,0 +1,8 @@
+/** @ignore */ /** */
+export { FieldType, FieldConfig } from '../../shared/types/field';
+export { Base } from './base';
+export { Table } from './table';
+export { Field } from './field';
+export { Record } from './record';
+export { Session } from './session';
+//# sourceMappingURL=models.d.ts.map

package/dist/types/src/interface/models/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../../../src/interface/models/models.ts"],"names":[],"mappings":"AACA,cAAc,CAAC,MAAM;AACrB,OAAO,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAChC,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC"}

package/dist/types/src/interface/sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../../src/interface/sdk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAK7C,OAAO,EAEH,eAAe,EAClB,MAAM,4BAA4B,CAAC;AAUpC,cAAc;AACd,qBAAa,iBAAkB,SAAQ,YAAY,CAAC,gBAAgB,CAAC;gBACrD,iBAAiB,EAAE,gBAAgB,CAAC,oBAAoB,CAAC;IA+DrE,cAAc;IACd,kBAAkB,IAAI,eAAe;CAYxC"}
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../../src/interface/sdk.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAK7C,OAAO,EAEH,eAAe,EAClB,MAAM,4BAA4B,CAAC;AAEpC,cAAc;AACd,qBAAa,iBAAkB,SAAQ,YAAY,CAAC,gBAAgB,CAAC;gBACrD,iBAAiB,EAAE,gBAAgB,CAAC,oBAAoB,CAAC;IAsDrE,cAAc;IACd,kBAAkB,IAAI,eAAe;CAYxC"}

package/dist/types/src/interface/ui/expand_record.d.ts

@@ -8,7 +8,8 @@ import { Record } from '../models/record';
  * @example
  * ```js
  * import {expandRecord} from '@airtable/blocks/interface/ui';
- * expandRecord(record);
+ *
+ * <button onClick={() => expandRecord(record)}>{record.name}</button>
  * ```
  * @docsPath UI/utils/expandRecord
  */

package/dist/types/src/interface/ui/expand_record.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expand_record.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/expand_record.ts"],"names":[],"mappings":"AAAA,0DAA0D,CAAC,MAAM;AACjE,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAExC;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAQjD"}
+{"version":3,"file":"expand_record.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/expand_record.ts"],"names":[],"mappings":"AAAA,0DAA0D,CAAC,MAAM;AACjE,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAExC;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAQjD"}

package/dist/types/src/interface/ui/initialize_block.d.ts

@@ -1,4 +1,34 @@
+/** @module @airtable/blocks/ui: initializeBlock */ /** */
+import * as React from 'react';
 import { InterfaceBlockSdk } from '../sdk';
+/** */
+type EntryElementFunction = () => React.ReactNode;
+/** @hidden */
+interface EntryPoints {
+    interface?: EntryElementFunction;
+}
+/**
+ * `initializeBlock` takes the top-level React component in your tree and renders it. It is conceptually similar to `ReactDOM.render`, but takes care of some Extensions-specific things.
+ *
+ * @param entryPoints An object with an `interface` property which is a function that returns your React Node.
+ *
+ * @example
+ * ```js
+ * import {initializeBlock} from '@airtable/blocks/interface/ui';
+ * import React from 'react';
+ *
+ * function App() {
+ *     return (
+ *         <div>Hello world 🚀</div>
+ *     );
+ * }
+ *
+ * initializeBlock({interface: () => <App />});
+ * ```
+ * @docsPath UI/utils/initializeBlock
+ */
+export declare function initializeBlock(entryPoints: EntryPoints): void;
 export declare function __injectSdkIntoInitializeBlock(_sdk: InterfaceBlockSdk): void;
 export declare function __resetHasBeenInitialized(): void;
+export {};
 //# sourceMappingURL=initialize_block.d.ts.map

package/dist/types/src/interface/ui/initialize_block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initialize_block.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/initialize_block.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAC,iBAAiB,EAAC,MAAM,QAAQ,CAAC;AAmFzC,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,iBAAiB,QAErE;AAGD,wBAAgB,yBAAyB,SAExC"}
+{"version":3,"file":"initialize_block.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/initialize_block.tsx"],"names":[],"mappings":"AAAA,mDAAmD,CAAC,MAAM;AAC1D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAC,iBAAiB,EAAC,MAAM,QAAQ,CAAC;AAOzC,MAAM;AACN,KAAK,oBAAoB,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC;AAClD,cAAc;AACd,UAAU,WAAW;IACjB,SAAS,CAAC,EAAE,oBAAoB,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,WAAW,QAkDvD;AAMD,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,iBAAiB,QAErE;AAGD,wBAAgB,yBAAyB,SAExC"}

package/dist/types/src/interface/ui/ui.d.ts

@@ -7,10 +7,10 @@ export { useRecords } from './use_records';
 export { useRunInfo } from './use_run_info';
 export { useSession } from './use_session';
 export { default as useGlobalConfig } from '../../shared/ui/use_global_config';
-export { default as useLoadable } from '../../shared/ui/use_loadable';
 export { default as useSynced } from '../../shared/ui/use_synced';
 export { default as useWatchable } from '../../shared/ui/use_watchable';
 export { default as withHooks } from '../../shared/ui/with_hooks';
 export { default as colors } from '../../shared/colors';
 export { default as colorUtils } from '../../shared/color_utils';
+export { loadCSSFromString, loadCSSFromURLAsync, loadScriptFromURLAsync, } from '../../shared/ui/remote_utils';
 //# sourceMappingURL=ui.d.ts.map

package/dist/types/src/interface/ui/ui.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/ui.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,CAAC;AAEZ,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACnC,OAAO,EAAC,mBAAmB,EAAC,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,UAAU,EAAC,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/ui.ts"],"names":[],"mappings":"AAEA,OAAO,IAAI,CAAC;AAEZ,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACnC,OAAO,EAAC,mBAAmB,EAAC,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,UAAU,EAAC,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAC,OAAO,IAAI,MAAM,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EACH,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,GACzB,MAAM,8BAA8B,CAAC"}

package/dist/types/src/interface/ui/use_custom_properties.d.ts

@@ -2,8 +2,25 @@ import { Table } from '../models/table';
 import { Base } from '../models/base';
 import { Field } from '../models/field';
 /**
- * TODO document
- * @hidden
+ * An object that represents a custom property that a block can set.
+ *
+ * ```
+ * type BlockPageElementCustomProperty = {key: string; label: string} & (
+ *   | {type: 'boolean'; defaultValue: boolean}
+ *   | {type: 'string'; defaultValue?: string}
+ *   | {
+ *       type: 'enum';
+ *       possibleValues: Array<{value: string; label: string}>;
+ *       defaultValue?: string;
+ *     }
+ *   | {
+ *       type: 'field';
+ *       table: Table;
+ *       possibleValues?: Array<Field>; // If not provided, all visible fields in the table will be shown in the dropdown.
+ *       defaultValue?: Field;
+ *     }
+ * );
+ * ```
  */
 type BlockPageElementCustomProperty = {
     key: string;
@@ -29,9 +46,39 @@ type BlockPageElementCustomProperty = {
     defaultValue?: Field;
 });
 /**
- * TODO document. Make sure to describe that getCustomProperties
- * should be wrapped in useCallback.
- * @hidden
+ * A hook for integrating configuration settings for your block with the Interface Designer properties
+ * panel. Under the hood, this uses {@link GlobalConfig} to store the custom property values.
+ *
+ * Returns an object with:
+ * - `customPropertyValueByKey`: an object mapping custom property keys to their current value.
+ * - `errorState`: an object with an `error` property if there was an error setting the custom properties
+ *
+ * @param getCustomProperties A function that returns an array of {@link BlockPageElementCustomProperty}.
+ * This function should have a stable identity, so it should either be defined at the top level of the
+ * file or wrapped in useCallback. It will receive an instance of {@link Base} as an argument.
+ *
+ * @example
+ * ```js
+ * import {useCustomProperties} from '@airtable/blocks/interface/ui';
+ *
+ * function getCustomProperties(base: Base) {
+ *     const table = base.tables[0];
+ *     const numberFields = table.fields.filter(field => field.type === FieldType.NUMBER);
+ *     return [
+ *         {key: 'title', label: 'Title', type: 'string', defaultValue: 'Chart'},
+ *         {key: 'xAxis', label: 'X-axis', type: 'field', table, possibleValues: numberFields},
+ *         {key: 'yAxis', label: 'Y-axis', type: 'field', table, possibleValues: numberFields},
+ *         {key: 'color', label: 'Color', type: 'enum', possibleValues: ['red', 'blue', 'green'], defaultValue: 'red'},
+ *         {key: 'showLegend', label: 'Show Legend', type: 'boolean', defaultValue: true},
+ *     ];
+ * }
+ *
+ * function MyApp() {
+ *     const {customPropertyValueByKey, errorState} = useCustomProperties(getCustomProperties);
+ * }
+ * ```
+ * @docsPath UI/hooks/useCustomProperties
+ * @hook
  */
 export declare function useCustomProperties(getCustomProperties: (base: Base) => Array<BlockPageElementCustomProperty>): {
     customPropertyValueByKey: {

package/dist/types/src/interface/ui/use_custom_properties.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use_custom_properties.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/use_custom_properties.ts"],"names":[],"mappings":"AASA,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAEtC,OAAO,EAAC,IAAI,EAAC,MAAM,gBAAgB,CAAC;AAEpC,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAQtC;;;GAGG;AACH,KAAK,8BAA8B,GAAG;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,GAAG,CAC/D;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,OAAO,CAAA;CAAC,GACxC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAC,GACvC;IACI,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,GACD;IACI,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,sFAAsF;IACtF,cAAc,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,KAAK,CAAC;CACxB,CACN,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,mBAAmB,CAC/B,mBAAmB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,CAAC,8BAA8B,CAAC,GAC3E;IAAC,wBAAwB,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAAC,UAAU,EAAE;QAAC,KAAK,EAAE,KAAK,CAAA;KAAC,GAAG,IAAI,CAAA;CAAC,CAkDzF"}
+{"version":3,"file":"use_custom_properties.d.ts","sourceRoot":"","sources":["../../../../../src/interface/ui/use_custom_properties.ts"],"names":[],"mappings":"AASA,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAEtC,OAAO,EAAC,IAAI,EAAC,MAAM,gBAAgB,CAAC;AAEpC,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAQtC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,8BAA8B,GAAG;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,GAAG,CAC/D;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,OAAO,CAAA;CAAC,GACxC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAC,GACvC;IACI,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,GACD;IACI,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,sFAAsF;IACtF,cAAc,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,KAAK,CAAC;CACxB,CACN,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,mBAAmB,CAC/B,mBAAmB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,CAAC,8BAA8B,CAAC,GAC3E;IAAC,wBAAwB,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAAC,UAAU,EAAE;QAAC,KAAK,EAAE,KAAK,CAAA;KAAC,GAAG,IAAI,CAAA;CAAC,CAkDzF"}

package/dist/types/src/shared/color_utils.d.ts

@@ -20,7 +20,7 @@ interface ColorUtils {
      * @param colorString
      * @example
      * ```js
-     * import {colorUtils, colors} from '@airtable/blocks/ui';
+     * import {colorUtils, colors} from '@airtable/blocks/[placeholder-path]/ui';
      *
      * colorUtils.getHexForColor(colors.RED);
      * // => '#ef3061'
@@ -38,7 +38,7 @@ interface ColorUtils {
      * @param colorString
      * @example
      * ```js
-     * import {colorUtils, colors} from '@airtable/blocks/ui';
+     * import {colorUtils, colors} from '@airtable/blocks/[placeholder-path]/ui';
      *
      * colorUtils.getRgbForColor(colors.PURPLE_DARK_1);
      * // => {r: 107, g: 28, b: 176}
@@ -56,7 +56,7 @@ interface ColorUtils {
      * @param colorString
      * @example
      * ```js
-     * import {colorUtils, colors} from '@airtable/blocks/ui';
+     * import {colorUtils, colors} from '@airtable/blocks/[placeholder-path]/ui';
      *
      * colorUtils.shouldUseLightTextOnColor(colors.PINK_LIGHT_1);
      * // => false

package/dist/types/src/shared/colors.d.ts

@@ -10,9 +10,9 @@ import { ObjectValues } from './private_utils';
  *
  * @example
  * ```js
- * import {Box, colors} from '@airtable/blocks/ui';
+ * import {colors, colorUtils} from '@airtable/blocks/[placeholder-path]/ui';
  *
- * <Box backgroundColor={colors.BLUE} />
+ * <div style={{backgroundColor: colorUtils.getHexForColor(colors.BLUE)}}>Hello world</div>
  * ```
  *
  * @docsPath UI/utils/colors