API / @aionbuilders/nabu

RegionNameParams

Type Stability: stable

Definition

TypeScript
import type { RegionNameParams } from '@aionbuilders/nabu';
TypeScript
interface RegionNameParams {
  label: string;
  name: string;
  prefix: string;
  title: string;
  type: string;
}

Properties

Properties of RegionNameParams
PropertyTypeDescription
labelstring

its computed label ("1.2 The bank"; may be empty)

namestring

the region named for a reader: its numbering prefix ("1.2"), else its title, else the name of its type

prefixstring

its numbering prefix ("1.2"; may be empty)

titlestring

its plain-text title (may be empty)

typestring

its type id

Source: src/lib/blocks/region/messages.js:15