Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog. This project started to follow semantic versioning as of version 1.0.0.

Not every commit needs to result in a change to this file (e.g. docs and chore commits). Every commit that affects the code in a way that consumers might care about should include edits to the 'Unreleased' section though. Breaking changes should be prefixed with **BREAKING:**.

Unreleased

No changes.

1.19.0 - 2025-06-06

• Add useColorScheme React hook, making a user's light/dark mode preference available in JavaScript. Airtable will also set color-scheme on extension iframes, so prefers-color-scheme media queries will match the user's Airtable preferences before browser-wide settings.

1.18.2 - 2024-09-25

• Upgrade Typescript version to 5.4.5
• Perform routine version upgrade to various packages, including react and eslint

1.18.1 - 2023-11-29

• Support React 17 as a peer dependency.

1.18.0 - 2023-09-15

• Add FieldType.AI_TEXT.

1.17.0 - 2023-04-14

No changes.

1.16.0 - 2023-03-08

• Update FieldType.DATE_TIME documentation to add additional time zones and clarify the write behavior.
• Visually refresh all icons

1.15.0 - 2022-09-23

• Add applyRowTemplate icon
• Update FieldType.DATE_TIME documentation to pre-announce write behavior for field level time zones
• Modify createRecordsAsync, updateRecordsAsync, convertStringToCellValue so that date string inputs to date time fields are interpreted correctly for utc or client time zone, fixing previously incorrect behaviors. In this new version, ambiguous strings like "2020-09-05T07:00:00" and "2020-09-08" will be interpreted according to the timeZone of the field, and nonambiguous string inputs with zone offset like "2020-09-05T07:00:00.000Z" and "2020-09-08T00:00:00-07:00" will be interpreted correctly as the underlying timestamp.

1.14.0 - 2022-07-26

• Add personalCloseup icon
• Add xCheckbox icon

1.13.0 - 2022-06-28

• Add ability to read (and watch) if a view is locked
• Update FieldType.MULTIPLE_COLLABORATOR documentation to include user group collaborator information

1.12.0 - 2022-06-22

• Update fallback value in Base.getMaxRecordsPerTable
• Add overlay icon
• Update cursor.setActiveTable and cursor.setActiveView documentation to describe fullscreen exit behavior correctly
• Fix an issue where rapidly subscribing and unsubscribing to a single field could cause a queryResult to be to incorrectly marked as loaded.
• Update API reference documentation to reflect 'extensions' in place of 'apps'
• Update examples in documentation to reflect 'extensions' in place of 'apps'

1.11.1 - 2022-04-13

• Update internal utilities for error reporting

1.11.0 - 2022-03-10

• Add workspace id to base object.
• Add Field.updateNameAsync
• Fixes a crash when a linked record is deleted
• Fixes a crash when a record containing a linked record is deleted and restored

1.10.2 - 2022-01-25

• Rare invariant failure addressed

1.10.1 - 2021-12-22

• Update examples for table, view and field URLs.
• Use keyof any instead of PropertyKey in type definition to avoid incompatibility with the "keyofStringsOnly" tsconfig option

1.10.0 - 2021-11-03

• Fix typo in cursor.ts documentation - thanks @m2creates!
• Add new calendarDay icon (and micro variant)
• Update documentation to include attachment url guidance
• Update field metadata writes documentation to mention that null will be coerced to ''
• Fix a bug when unloading data from a linkedRecordQueryResult after a table deletion
• Update children prop of Link component to be optional

1.9.0 - 2021-09-15

• Update documentation for FieldType.CHECKBOX cell read & write types to be more accurate.
• Fetching field types & configs is now cached, making it more performant.
• Field descriptions can now be edited and specified when creating a new field:
  • Added field.updateDescriptionAsync.
  • Added optional description argument to table.createFieldAsync.
  • Added optional description property to field objects accepted by base.createTableAsync.

1.8.0 - 2021-07-12

• Add opts argument to Field.updateOptionsAsync with enableSelectFieldChoiceDeletion opt.
• Add prefersSingleRecordLink to field.options for MULTIPLE_RECORD_LINKS type fields.
• Add new timeline icon (and micro variant).

1.7.2 - 2021-05-26

• Add FieldType.EXTERNAL_SYNC_SOURCE.

1.7.1 - 2021-05-21

No changes.

1.7.0 - 2021-05-13

• Add onBlur and onFocus support to Input and InputSynced UI components.

1.6.0 - 2021-05-12

• Add color property to base to access the background color of the base, as well as the color watch key
• Update documentation text for GlobalConfig with increased 150kb limit.
• Add getMaxRecordsPerTable to base

1.5.1 - 2021-03-04

No changes.

1.5.0 - 2021-02-25

• Add type exports for Cursor & Session to @airtable/blocks/models.
• Add type exports for GlobalConfig, Watchable, & Viewport to @airtable/blocks/types.
• Add boltList, boltListMicro, contacts, contactsMicro, megaphone, megaphoneMicro, shareWithBolt and shareWithBoltMicro icons.
• Increase spacing between label and description nodes in FormField.
• Support creating (but not updating) MULTIPLE_RECORD_LINKS fields using table.createFieldAsync.
• Add isCancelButtonDisabled and isConfirmButtonDisabled props to ConfirmationDialog.
• Add config property to Field, which is a new FieldConfig discriminated union type that provides easier access to field options.
• Improve type definitions for getHexForColor and getRgbForColor.

1.4.1 - 2021-01-21

No changes.

1.4.0 - 2021-01-19

• DEPRECATED: importing the Base's Cursor instance from the main entrypoint, e.g. import {cursor} from '@airtable/blocks';. Use the useCursor React Hook instead.
• DEPRECATED: importing the Base's Session instance from the main entrypoint, e.g. import {session} from '@airtable/blocks';. Use the useSession React Hook instead.

1.3.0 - 2021-01-07

• Fix crash when deleting views.
• Add BaseProvider to allow rendering Components outside of the App's React tree

1.2.5 - 2020-12-10

No changes.

1.2.4 - 2020-12-10

No changes.

1.2.3 - 2020-12-09

• Stopped exporting an internal class that was causing typescript checking to fail on version 1.2.2

1.2.2 - 2020-12-08

• Fixed a bug in useRecordActionData that caused it to crash on version 1.2.1

1.2.1 - 2020-11-23

• Fixed a bug that prevented TableOrViewQueryResult from notifying watchers about the creation/deletion of sorted fields.
• Fixed a bug where deleting and undeleting a table that was already loaded caused the App to crash.
• DEPRECATED: importing the UI namespace from the main entrypoint, e.g. import {UI} from '@airtable/blocks';. Use import * as UI from '@airtable/blocks/ui/ui'; instead.
• DEPRECATED: importing the models namespace from the main entrypoint, e.g. import {models} from '@airtable/blocks';. Use import * as models from '@airtable/blocks/models/models'; instead.

1.2.0 - 2020-10-23

• Added automations and fixed the SVG path for personalAuto in Icon.
• Fixed a bug that caused an App to crash when creating a new table before the App has loaded.
• Fixed a bug in watching/unwatching keys of LinkedRecordQueryResult models. Watching/unwatching isDataLoaded no longer affects the model's "loaded" state.
• Fixed a bug introduced in v1.0.0 in RecordCard when rendering a record that has a lookup field of an attachment field.

1.1.0 - 2020-09-29

• DEPRECATED: "blocks" as an icon name. Use <Icon name="apps" .../> instead.
• Fixed bugs introduced in v1.0.0 that broke using lookup cell values with Record.getCellValueAsString, aggregator.aggregate and aggregator.aggregateToString

1.0.1 - 2020-09-24

• Fixed bug where Select, SelectButtons, and Synced variants behaved incorrectly when there were multiple items with the same value.
• Fix a bug using lookup cell values with <CellRenderer /> introduced in v1.0.0

1.0.0 - 2020-09-14

• BREAKING: The cell value format for lookup fields (FieldType.MULTIPLE_LOOKUP_VALUES) is now Array<{linkedRecordId: RecordId, value: CellValue}>
• BREAKING: Remove Record.primaryCellValue and Record.primaryCellValueAsString, as well as the primaryCellValue watchable key on Record. These APIs were deprecated in v0.0.45
• BREAKING: Remove legacy record creation format. All calls to Table.createRecordAsync / Table.createRecordsAsync must define record field mappings under a fields key. These APIs were deprecated in v0.0.41.

0.0.55 - 2020-09-02

No changes.

0.0.54 - 2020-08-12

• Remove unstable_ prefix from Field.updateOptionsAsync, Table.createFieldAsync, and Base.createTableAsync. See Changing base schema for full details.

0.0.53 - 2020-06-24

• Fix a typo in the docs for globalConfig.setAsync.
• Added an explicit box-sizing: border-box; to the inner div of ChoiceToken, to prevent accidentally inheriting different box-sizing values.

0.0.52 - 2020-06-08

• Add FieldType.CREATED_BY, FieldType.LAST_MODIFIED_BY, and FieldType.BUTTON.
• Add record action APIs! Use one in your block to handle "open block" requests from a button field.
  • useRecordActionData
  • registerRecordActionDataCallback

0.0.51 - 2020-05-28

• Fix a bug introduced in 0.0.48 that caused typechecking errors for blocks using TypeScript.

0.0.50 - 2020-05-28

No changes.

0.0.49 - 2020-05-21

• Adds optional renderInvalidCellValue prop to RecordCard and CellRenderer to render a component if validation fails.

0.0.48 - 2020-04-30

No changes.

0.0.47 - 2020-04-23

• UI components that don't depend on base data can now be used outside of the blocks environment.

0.0.46 - 2020-04-16

• FieldType.RICH_TEXT has been added, which encompasses long text fields with the new rich text formatting option enabled. (See Airtable's announcement regarding rich text formatting in long text fields)
• Switch and SwitchSynced now truncate the label.
• Fix a bug where RecordCard performs the default expand record behavior, even if an onClick override is supplied. It now properly handles overrides as described in the documentation. This fix also applies to onRecordClick in RecordCardList.
• Beta: New field and table writes API! You can now create tables and fields and update field options.
  • base.unstable_createTableAsync
  • table.unstable_createFieldAsync
  • field.unstable_updateOptionsAsync
  • These APIs are unstable and may have breaking changes in the future.
  • Not all field types are supported at this time. Refer to FieldType documentation for details.

0.0.45 - 2020-03-31

• DEPRECATED: record.primaryCellValue and record.primaryCellValueAsString.
  • The primaryCellValue watch key on record is also deprecated - use the name watch key instead.
• Add the following APIs to match the new scripting block:
  • Convenience model getters. These are useful when you're working on a block for a specific base, but best-practice for more generic blocks is to prefer the existing ById/ByName methods.
    • base.getCollaboratorIfExists
    • base.getCollaborator
    • base.getTableIfExists
    • base.getTable
    • table.getFieldIdExists
    • table.getField
    • table.getViewIfExists
    • table.getView
  • Async select queries. For creating UIs from a query, the best practice is still to use useRecords etc. Directly querying data is useful for one-off data processing though.
    • table.selectRecordsAsync
    • view.selectRecordsAsync
    • view.selectMetadataAsync
    • record.selectLinkedRecordsFromCellAsync
  • record.name replaces record.primaryCellValueAsString.
• Fix some incorrectly redacted internal typescript types

0.0.44 - 2020-03-27

• TextButton now supports including an icon without a label.
• Properly export the useSynced hook.
• Errors now output model names instead of IDs when available.
• Fix a positioning bug with SelectButtons where unwanted empty space could appear when the component is used in a scrollable list.

0.0.43 - 2020-02-28

• Export the useSynced hook for syncing a component to GlobalConfig.

0.0.42 - 2020-02-10

• BREAKING: Field type and view type enums are now exported from '@airtable/blocks/models' as FieldType and ViewType (previously fieldTypes and viewTypes). Relatedly, these types are no longer exported from '@airtable/blocks/types', as they can now be referenced from the model exports.
• Updates to record convenience hooks
  • useRecords now accepts a Table or View and optional RecordQueryResultOpts. Passing a RecordQueryResult is still supported.
  • useRecordIds now accepts a Table or View and optional RecordIdQueryResultOpts. Passing a RecordQueryResult is still supported.
  • useRecordById now accepts a Table or View and optional SingleRecordQueryResultOpts. Passing a RecordQueryResult is still supported.
• Added cursor.selectedFieldIds which returns the field IDs that are selected in grid view

0.0.41 - 2020-01-27

• BREAKING: useWatchable will now throw an error if the second argument keys is undefined. Previously, this would no-op.
• Added support for setActiveTable and setActiveView to the cursor API. These can be used to manipulate the current table and/or view on the main Airtable page from inside a block.
• Table.createRecordsAsync now accepts an array of objects containing a fields object of field -> cell value mappings, rather an accepting field -> cell value mappings directly. This brings its API in line with updateRecordsAsync and other Airtable APIs. The old behavior is still supported but has been deprecated and will be removed in a future version.
• Fixed issue where blocks would crash in MS Edge due to a browser bug with super method calls.
• Changed default Tooltip placementOffsetX and placementOffsetY to 8 pixels. undefined. Previously, this would no-op.
• Added default blue barColor to ProgressBar.

0.0.40 - 2020-01-09

• Added permission checks that don't require specifying a table to session:
  • session.checkPermissionsForUpdateRecords()
  • session.hasPermissionToUpdateRecords()
  • session.checkPermissionsForCreateRecords()
  • session.hasPermissionToCreateRecords()
  • session.checkPermissionsForDeleteRecords()
  • session.hasPermissionToDeleteRecords()

0.0.39 - 2019-12-12

• Changed the font sizes for the size variants of Select and Button.
• useWatchable now supports single string watch keys being passed in (as well as the existing array support)
• Fixed bug where shouldAllowPickingNone didn't work in FieldPicker and FieldPickerSynced.
• Updated fullscreen and fullscreenMicro icons.
• Updated UI.Button component to better support icon buttons containing no text. An error is now logged to the console if you attempt to use a UI.Button component with no text/children and no aria-label.

0.0.36 - 2019-11-18

• Added table.description and field.description, and description watch key on table and field.

0.0.35 - 2019-11-11

• UI library
  • New API for styling UI components. Each component now exposes a certain set of CSS properties as React props. Styling via the className and style props is still supported but is no longer recommended. For more information, see the documentation for style props.
  • New components:
    • Text and Heading for typography.
    • Label and FormField for labeling controls or form fields.
    • TextButton for buttons that can be rendered inline with text.
  • BREAKING: Toggle has been renamed to Switch.
  • BREAKING: Button and Switch no longer accept the theme prop. Instead, you can specify the colors for these components with the variant prop.
  • Link also supports the variant prop, which determines the text color of the link.
  • Button, Input, Link, SelectButtons, Select, Switch, and the model picker components can now be resized via the size prop (one of small, default, or large).
  • Button, Icon, Input, Link, SelectButtons, Select, Switch, and the model picker components are now functional components that use the React.forwardRef API.
  • SelectButtons is now keyboard/screenreader accessible.
• Typescript
  • BREAKING The SDK has been migrated from Flow to TypeScript. We no longer provide flow type definitions with the release of the SDK. TypeScript definitions are provided instead.

0.0.34 - 2019-10-04

• Fix a regression where UI.ConfirmationDialog would crash the block.
• Allow passing an array of models to useWatchable to watch several models at once.
• BREAKING: fieldTypes.LOOKUP is now fieldTypes.MULTIPLE_LOOKUP_VALUES. The underlying string has also changed from lookup to multipleLookupValues.
• Fix a regression where cover images in UI.RecordCard would render as [Object object].

0.0.33 - 2019-09-26

• New settings button helpers: useSettingsButton, settingsButton.show() and settingsButton.hide().
• BREAKING: settingsButton.isVisible is no longer settable. Use settingsButton.show() and settingsButton.hide() instead.

0.0.32 - 2019-09-20

• BREAKING: Removed localStorage and sessionStorage wrappers.
• Fix a bug where the value prop wouldn't get correctly passed through to Input

0.0.31 - 2019-09-18

• New record writes API! You can now create, update, and delete records directly from your block. Check out the new writes guide for more information.
• BREAKING: several globalConfig APIs have changed to be consistent with the new record writes & permissions APIs:
  • globalConfig.set() has been removed - use the new globalConfig.setAsync() method instead.
  • globalConfig.canSet() has been renamed to globalConfig.hasPermissionToSet().
  • globalConfig.setPaths() has been removed - use the new globalConfig.setPathsAsync() method instead.
  • globalConfig.canSetPaths() has been renamed to globalConfig.hasPermissionToSetPaths().
• BREAKING: Remove models.generateGuid(). Use an ID generator like uuid instead.
• BREAKING: Deprecated UI.AutocompletePopover.
• Upgrade flow to 0.106.3
• Fix a flow error with react-window.
• view.selectRecords() now colors records according to that view by default.
• Allow passing an array of models to useLoadable to load several things at once.

0.0.30 - 2019-08-26

No changes.

0.0.29 - 2019-08-22

No changes.

0.0.28 - 2019-08-21

No changes.

0.0.27 - 2019-08-21

No changes.

0.0.26 - 2019-08-19

• UI.RecordCardList: fixed a bug where records weren't expanded by default when clicked.

0.0.25 - 2019-08-19

• Add Print Records block docs example block

0.0.24 - 2019-08-14

No changes.

0.0.23 - 2019-08-09

Fixed

• The disabled attribute on <Select> components (including model pickers and synced model pickers) now correctly disables the element

0.0.22 - 2019-07-18

No changes.

0.0.21 - 2019-07-18

No changes.

0.0.20 - 2019-07-15

Fixed

• A bug with UI.Toggle that made it difficult to style

0.0.19 - 2019-07-11

No changes.

0.0.18 - 2019-07-10

• Update documentation links & eslint-plugin-blocks

0.0.17 - 2019-07-09

No changes.

0.0.16 - 2019-07-05

• BREAKING: Removed view.visibleFields and view.allFields - use view.selectMetadata instead
• Added view.selectMetadata() for querying a view's field order and list of visible fields

0.0.15 - 2019-07-03

No changes.

0.0.14 - 2019-07-02

• BREAKING: Removed currentUser from Base since it is now accessible through Session.
• BREAKING: Renamed QueryResult to RecordQueryResult
• Added base.watch('schema') to get notified when base schema changes.
• Added Session to expose data about the current user's session.
• Added globalConfig.watch('*') to get notified of any global config key change.
• Added useGlobalConfig() to subscribe to global config changes from a react component.

0.0.13 - 2019-06-21

Removed

• BREAKING: Removed createDataContainer. Use useWatchable or other hooks instead.
• BREAKING: FieldIcon no longer accepts arbitrary props - only those in it's propTypes can be used.

Added

• This changelog!

Fixed

• FieldPicker placeholder typo
• SVGElement flow error