Extensions

Press shift + S to search API reference.

React hook

useViewMetadata

View source

Returns a ViewMetadataQueryResult for the specified view and re-renders whenever the view metadata changes. Suspends if the view is not already loaded.

import {useBase, useViewMetadata} from '@airtable/blocks/ui';
function ViewFields({view}) {
const viewMetadata = useViewMetadata(view);
return (
<ul>
{viewMetadata.visibleFields.map(field => (
<li key={field.id}>{field.name}</li>
))}
</ul>
);
}

Function signatures

function (viewOrViewMetadataQueryResult: View | ViewMetadataQueryResult) => ViewMetadataQueryResult
viewOrViewMetadataQueryResult

The View or ViewMetadataQueryResult to watch and use metadata from.

function (viewOrViewMetadataQueryResult?: null | undefined) => null
viewOrViewMetadataQueryResult

The View or ViewMetadataQueryResult to watch and use metadata from.

function (viewOrViewMetadataQueryResult?: View | ViewMetadataQueryResult | null | undefined) => ViewMetadataQueryResult | null
viewOrViewMetadataQueryResult

The View or ViewMetadataQueryResult to watch and use metadata from.