Skip to main content

Input

Input as a built-in interactive object can be required from the operator and follow-up interactions.

Note that each interactive input is asynchronous, which means that await must be added before each method can be invoked.

textAsync​

The component will prompt the user to enter a text.

Interface​

async function (label?: string) => Promise<string>;

Example​

const name = await input.textAsync("Please enter your name:");

viewAsync​

The component will prompt the user to select a view in the specified Datasheet.

Interface​

async function (label: string, datasheet: Datasheet) => Promise<View>;

Example​

const datasheet = await space.getActiveDatasheetAsync();
const view = await input.viewAsync("Please select a view:", datasheet);

fieldAsync​

The component will prompt the user to select a field in the Datasheet.

Interface​

async function (label: string, datasheet: Datasheet) => Promise<Field>;

Example​

const datasheet = await space.getActiveDatasheetAsync();
const field = await input.fieldAsync("Please select a field:", datasheet);

recordAsync​

The component will prompt the user to select a record in the specified Datasheet.

Interface​

async function (label: string, datasheet: Datasheet) => Promise<Record>;

Example​

const datasheet = await space.getActiveDatasheetAsync();
const record = await input.recordAsync("Please select a record:", datasheet);