import { BlockDefinition, ComponentRegistryEntry, FieldBlockDefinition, ResolvableArray, ResolvableBoolean, ResolvableNumber, ResolvableObject, ResolvableString } from "@ministryofjustice/hmpps-forge/core/components";
import { ValidationExpr } from "@ministryofjustice/hmpps-forge/core/authoring";
import { Environment } from "nunjucks";
//#region forge-govuk-components/src/components/accordion/govukAccordion.d.ts
/**
 * Heading configuration for an accordion section.
 * Displays as the clickable header that expands/collapses the section.
 */
interface AccordionItemHeading {
  /** Plain text content for the heading. Required unless html is provided. */
  text?: ResolvableString;
  /**
   * HTML content for the heading. Takes precedence over text.
   * Note: The header is inside a `<button>` element, so only phrasing content is allowed.
   */
  html?: ResolvableString;
}
/**
 * Summary line configuration for an accordion section.
 * Optional additional text displayed alongside the heading.
 */
interface AccordionItemSummary {
  /** Plain text content for the summary line. */
  text?: ResolvableString;
  /**
   * HTML content for the summary line. Takes precedence over text.
   * Note: The summary line is inside a `<button>` element, so only phrasing content is allowed.
   */
  html?: ResolvableString;
}
/**
 * Content configuration for an accordion section.
 * The content that is shown when the section is expanded.
 */
interface AccordionItemContent {
  /** Plain text content for the section. Required unless html or blocks is provided. */
  text?: ResolvableString;
  /** HTML content for the section. Takes precedence over text. */
  html?: ResolvableString;
  /** Child blocks to render in the section. Takes precedence over text/html. */
  blocks?: BlockDefinition[];
}
/**
 * An individual section within the accordion.
 */
interface AccordionItem {
  /** The heading of the accordion section. Required. */
  heading: AccordionItemHeading;
  /** Optional summary line displayed alongside the heading. */
  summary?: AccordionItemSummary;
  /** The content of the accordion section. Required. */
  content: AccordionItemContent;
  /** Whether the section should be expanded when the page loads. Defaults to false. */
  expanded?: ResolvableBoolean;
  /**
   * Conditional visibility for this section. When the evaluated value is `false`,
   * the section is omitted from rendering. Defaults to showing the section.
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Accordion component.
 *
 * Renders as a vertically stacked set of interactive headings that reveal or hide content.
 *
 * @see https://design-system.service.gov.uk/components/accordion/
 * @example
 * ```typescript
 * GovUKAccordion({
 *   id: 'accordion-default',
 *   items: [
 *     {
 *       heading: { text: 'Writing well for the web' },
 *       content: { text: 'This is the content for the first section.' },
 *     },
 *     {
 *       heading: { text: 'Writing well for specialists' },
 *       summary: { text: 'Guidance for technical writers' },
 *       content: { text: 'This is the content for the second section.' },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With child blocks as content
 * ```typescript
 * GovUKAccordion({
 *   id: 'accordion-with-blocks',
 *   items: [
 *     {
 *       heading: { text: 'Section with nested components' },
 *       content: {
 *         blocks: [
 *           GovUKInsetText({ text: 'Important information' }),
 *           GovUKWarningText({ text: 'Warning message' }),
 *         ],
 *       },
 *     },
 *   ],
 * })
 * ```
 */
interface GovUKAccordion extends BlockDefinition {
  /**
   * Unique ID for the accordion.
   * Must be unique across the domain if `rememberExpanded` is true, as the expanded state
   * persists across page loads using session storage.
   */
  id: ResolvableString;
  /** The sections within the accordion. Required. Supports dynamic expressions. */
  items: ResolvableArray<AccordionItem>;
  /** Heading level for section headings, from 1 to 6. Defaults to 2. */
  headingLevel?: ResolvableNumber;
  /**
   * Whether the expanded/collapsed state should persist across page loads.
   * Uses session storage. Defaults to true.
   */
  rememberExpanded?: ResolvableBoolean;
  /** Text for the "Hide all sections" button when all sections are expanded. */
  hideAllSectionsText?: ResolvableString;
  /** Text for the "Show all sections" button when at least one section is collapsed. */
  showAllSectionsText?: ResolvableString;
  /** Text for the "Hide" button within each expanded section. */
  hideSectionText?: ResolvableString;
  /** Text for the "Show" button within each collapsed section. */
  showSectionText?: ResolvableString;
  /** Accessible label text when section is expanded. Defaults to "Hide this section". */
  hideSectionAriaLabelText?: ResolvableString;
  /** Accessible label text when section is collapsed. Defaults to "Show this section". */
  showSectionAriaLabelText?: ResolvableString;
  /** Additional CSS classes for the accordion element. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the accordion element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Accordion component.
 *
 * Renders as a vertically stacked set of interactive headings that reveal or hide content.
 *
 * @see https://design-system.service.gov.uk/components/accordion/
 * @example
 * ```typescript
 * GovUKAccordion({
 *   id: 'accordion-default',
 *   items: [
 *     {
 *       heading: { text: 'Writing well for the web' },
 *       content: { text: 'This is the content for the first section.' },
 *     },
 *     {
 *       heading: { text: 'Writing well for specialists' },
 *       summary: { text: 'Guidance for technical writers' },
 *       content: { text: 'This is the content for the second section.' },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With child blocks as content
 * ```typescript
 * GovUKAccordion({
 *   id: 'accordion-with-blocks',
 *   items: [
 *     {
 *       heading: { text: 'Section with nested components' },
 *       content: {
 *         blocks: [
 *           GovUKInsetText({ text: 'Important information' }),
 *           GovUKWarningText({ text: 'Warning message' }),
 *         ],
 *       },
 *     },
 *   ],
 * })
 * ```
 */
declare const GovUKAccordion: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKAccordion, string>;
//#endregion
//#region forge-govuk-components/src/components/breadcrumbs/govukBreadcrumbs.d.ts
/**
 * Individual breadcrumb item configuration.
 */
interface BreadcrumbItem {
  /** Plain text content for the breadcrumb. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the breadcrumb. Takes precedence over text. */
  html?: ResolvableString;
  /** Link URL for the breadcrumb. If not specified, renders as plain text. */
  href?: ResolvableString;
  /** Custom HTML attributes for the breadcrumb item. */
  attributes?: Record<string, any>;
  /**
   * Conditional visibility for this breadcrumb. When the evaluated value is `false`,
   * the item is omitted from rendering. Defaults to showing the item.
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Breadcrumbs component.
 *
 * Use this to help users understand where they are in the website's structure
 * and navigate back to higher levels.
 *
 * @see https://design-system.service.gov.uk/components/breadcrumbs/
 * @example
 * ```typescript
 * GovUKBreadcrumbs({
 *   items: [
 *     { text: 'Home', href: '/' },
 *     { text: 'Passports, travel and living abroad', href: '/browse/abroad' },
 *     { text: 'Travel abroad' },
 *   ],
 * })
 * ```
 */
interface GovUKBreadcrumbs extends BlockDefinition {
  /** The breadcrumb items to display. Required. */
  items: ResolvableArray<BreadcrumbItem>;
  /** When true, collapses to first and last item only on mobile. */
  collapseOnMobile?: ResolvableBoolean;
  /** Accessibility label for the navigation landmark. Defaults to "Breadcrumb". */
  labelText?: ResolvableString;
  /** Additional CSS classes for the breadcrumbs container. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the breadcrumbs container. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Breadcrumbs component.
 *
 * Use this to help users understand where they are in the website's structure
 * and navigate back to higher levels.
 *
 * @see https://design-system.service.gov.uk/components/breadcrumbs/
 * @example
 * ```typescript
 * GovUKBreadcrumbs({
 *   items: [
 *     { text: 'Home', href: '/' },
 *     { text: 'Passports, travel and living abroad', href: '/browse/abroad' },
 *     { text: 'Travel abroad' },
 *   ],
 * })
 * ```
 */
declare const GovUKBreadcrumbs: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKBreadcrumbs, string>;
//#endregion
//#region forge-govuk-components/src/components/select-input/govukSelectInput.d.ts
/**
 * Select item configuration
 */
interface SelectItem {
  /** Value for the option. If omitted, the value is taken from the text content. */
  value?: ResolvableString;
  /** Text for the option item. */
  text: ResolvableString;
  /** Whether the option should be selected when the page loads. */
  selected?: ResolvableBoolean;
  /** Sets the option item as disabled. */
  disabled?: ResolvableBoolean;
  /** HTML attributes to add to the option. */
  attributes?: Record<string, any>;
  /** Conditional visibility for this option. */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Select Input component.
 *
 * @see https://design-system.service.gov.uk/components/select/
 * @example
 * ```typescript
 * GovUKSelectInput({
 *   code: 'country',
 *   label: 'Select your country',
 *   items: [
 *     { value: '', text: 'Choose an option' },
 *     { value: 'gb', text: 'United Kingdom' },
 *     { value: 'fr', text: 'France' },
 *   ],
 * })
 * ```
 */
interface GovUKSelectInput extends FieldBlockDefinition {
  /**
   * The ID of the select. Defaults to the value of `code` if not provided.
   * @example 'country-select'
   */
  id?: ResolvableString;
  /**
   * The items within the select component.
   * Each item represents an option in the dropdown.
   *
   * @example [{ value: '', text: 'Choose an option' }, { value: 'uk', text: 'United Kingdom' }]
   */
  items: ResolvableArray<SelectItem>;
  /**
   * The label used by the select component.
   * Can be a simple string or a complex object with additional properties.
   *
   * @example 'Select your country'
   * @example { text: 'Country', classes: 'govuk-label--l' }
   */
  label: ResolvableString | {
    /** Text content of the label */
    text?: ResolvableString;
    /** HTML content of the label (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the label */
    classes?: ResolvableString;
    /** For attribute - automatically set if not provided */
    for?: ResolvableString;
    /** Whether to render the label as a page heading (wrapped in h1) */
    isPageHeading?: ResolvableBoolean;
    /** Additional HTML attributes for the label */
    attributes?: Record<string, any>;
  };
  /**
   * Can be used to add a hint to the select component.
   * Provides additional context or instructions for the user.
   *
   * @example 'Select the country where you currently live'
   */
  hint?: ResolvableString | {
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /**
   * If `true`, select box will be disabled.
   * Use the `disabled` option on each individual item to only disable certain options.
   * @example true
   */
  disabled?: ResolvableBoolean;
  /**
   * One or more element IDs to add to the `aria-describedby` attribute.
   * Used to provide additional descriptive information for screenreader users.
   *
   * @example 'country-select-help'
   */
  describedBy?: ResolvableString;
  /**
   * Additional options for the form group containing the select component.
   */
  formGroup?: {
    /** Classes to add to the form group wrapper. */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /** Content to add before the select element. */
    beforeInput?: {
      /** Text content to add before the select */
      text?: ResolvableString;
      /** HTML content to add before the select (takes precedence over text) */
      html?: ResolvableString;
    };
    /** Content to add after the select element. */
    afterInput?: {
      /** Text content to add after the select */
      text?: ResolvableString;
      /** HTML content to add after the select (takes precedence over text) */
      html?: ResolvableString;
    };
  };
  /**
   * Additional CSS classes to add to the select element.
   * @example 'govuk-!-width-one-half'
   */
  classes?: ResolvableString;
  /**
   * Additional HTML attributes to add to the select element.
   * @example { 'data-module': 'accessible-autocomplete' }
   */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Select Input component.
 *
 * @see https://design-system.service.gov.uk/components/select/
 * @example
 * ```typescript
 * GovUKSelectInput({
 *   code: 'country',
 *   label: 'Select your country',
 *   items: [
 *     { value: '', text: 'Choose an option' },
 *     { value: 'gb', text: 'United Kingdom' },
 *     { value: 'fr', text: 'France' },
 *   ],
 * })
 * ```
 */
declare const GovUKSelectInput: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKSelectInput, string>;
//#endregion
//#region forge-govuk-components/src/components/pagination/govukPagination.d.ts
/**
 * Pagination link configuration for previous/next navigation.
 */
interface PaginationLink {
  /** The link's URL. Required. */
  href: ResolvableString;
  /** Text content of the link. Defaults to "Previous page" or "Next page". */
  text?: ResolvableString;
  /** HTML content of the link. Takes precedence over text. */
  html?: ResolvableString;
  /** Label underneath the link providing context (e.g., "Introduction"). */
  labelText?: ResolvableString;
  /** Custom HTML attributes for the anchor element. */
  attributes?: Record<string, any>;
  /**
   * Conditional visibility for this link. When the evaluated value is `false`,
   * the link is omitted from rendering. Defaults to showing the link.
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * Pagination item for numbered page navigation.
 */
interface PaginationItem {
  /** The page number text. Required unless ellipsis is true. */
  number?: ResolvableString;
  /** Visually hidden label for screen readers (e.g., "Page 1"). */
  visuallyHiddenText?: ResolvableString;
  /** The link's URL. Required unless ellipsis is true. */
  href?: ResolvableString;
  /** Set to true to indicate the current page. */
  current?: ResolvableBoolean;
  /** Set to true to render an ellipsis instead of a page number. */
  ellipsis?: ResolvableBoolean;
  /** Custom HTML attributes for the anchor element. */
  attributes?: Record<string, any>;
  /**
   * Conditional visibility for this item. When the evaluated value is `false`,
   * the item is omitted from rendering. Defaults to showing the item.
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Pagination component.
 *
 * Use this to navigate between pages. Supports previous/next links with labels, and
 * numbered page navigation.
 *
 * @see https://design-system.service.gov.uk/components/pagination/
 * @example
 * ```typescript
 * GovUKPagination({
 *   previous: {
 *     href: '/docs/introduction',
 *     labelText: 'Introduction',
 *   },
 *   next: {
 *     href: '/docs/getting-started',
 *     labelText: 'Getting Started',
 *   },
 * })
 * ```
 */
interface GovUKPagination extends BlockDefinition {
  /** Link to the previous page. */
  previous?: PaginationLink;
  /** Link to the next page. */
  next?: PaginationLink;
  /** Numbered page items for multi-page navigation. */
  items?: ResolvableArray<PaginationItem>;
  /** Accessibility label for the navigation landmark. Defaults to "Pagination". */
  landmarkLabel?: ResolvableString;
  /** Additional CSS classes for the pagination nav element. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the pagination nav element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Pagination component.
 *
 * Use this to navigate between pages. Supports previous/next links with labels, and
 * numbered page navigation.
 *
 * @see https://design-system.service.gov.uk/components/pagination/
 * @example
 * ```typescript
 * GovUKPagination({
 *   previous: {
 *     href: '/docs/introduction',
 *     labelText: 'Introduction',
 *   },
 *   next: {
 *     href: '/docs/getting-started',
 *     labelText: 'Getting Started',
 *   },
 * })
 * ```
 */
declare const GovUKPagination: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKPagination, string>;
//#endregion
//#region forge-govuk-components/src/components/summary-list/govukSummaryList.d.ts
/**
 * Action item for summary list rows or card headers.
 * Renders as a link with optional visually hidden text for accessibility.
 */
interface SummaryListActionItem {
  /** The value of the link's `href` attribute. Required. */
  href: ResolvableString;
  /** Plain text content for the action link. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the action link. Takes precedence over text. */
  html?: ResolvableString;
  /**
   * Additional accessible text appended to the action link.
   * Useful for providing context when the action text alone is not descriptive enough.
   * For example, "Change" might need "name" appended to become "Change name".
   */
  visuallyHiddenText?: ResolvableString;
  /** Additional CSS classes for the action link. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the action link element. */
  attributes?: Record<string, any>;
}
/**
 * Actions configuration for summary list rows or card headers.
 * Contains an array of action items and optional wrapper classes.
 */
interface SummaryListActions {
  /** The action link items to display. */
  items?: ResolvableArray<SummaryListActionItem>;
  /** Additional CSS classes for the actions wrapper element. */
  classes?: ResolvableString;
}
/**
 * Key (label) for a summary list row.
 * Displays on the left side of the row as the reference/label.
 */
interface SummaryListKey {
  /** Plain text content for the key. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the key. Takes precedence over text. */
  html?: ResolvableString;
  /** Additional CSS classes for the key wrapper. */
  classes?: ResolvableString;
}
/**
 * Value for a summary list row.
 * Displays on the right side of the row as the content/answer.
 */
interface SummaryListValue {
  /** Plain text content for the value. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the value. Takes precedence over text. */
  html?: ResolvableString;
  /** Child blocks to render for the value. Takes precedence over text/html. */
  blocks?: BlockDefinition[];
  /** Additional CSS classes for the value wrapper. */
  classes?: ResolvableString;
}
/**
 * A row in the summary list, containing a key-value pair and optional actions.
 */
interface SummaryListRow {
  /** The reference content (key/label) for this row. Required. */
  key: SummaryListKey;
  /** The value content for this row. */
  value?: SummaryListValue;
  /** Optional action links for this row (e.g., "Change", "Remove"). */
  actions?: ResolvableObject<SummaryListActions>;
  /** Additional CSS classes for the row div element. */
  classes?: ResolvableString;
  /**
   * Conditional visibility for this row. When the evaluated value is `false`,
   * the row is omitted from rendering. Defaults to showing the row.
   *
   * @example Answer('contactMethod').match(Condition.Equals('email'))
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * Title configuration for a summary card header.
 */
interface SummaryCardTitle {
  /** Plain text content for the card title. Takes precedence if html is not provided. */
  text?: ResolvableString;
  /** HTML content for the card title. Takes precedence over text. */
  html?: ResolvableString;
  /** Heading level for the title, from 1 to 6. Defaults to 2. */
  headingLevel?: ResolvableNumber;
  /** Additional CSS classes for the title wrapper. */
  classes?: ResolvableString;
}
/**
 * Summary card configuration to wrap the summary list.
 * When provided, the summary list is wrapped in a card with a header.
 */
interface SummaryCard {
  /** Title displayed in the card header. */
  title?: SummaryCardTitle;
  /** Action links displayed in the card header. */
  actions?: ResolvableObject<SummaryListActions>;
  /** Additional CSS classes for the card container. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the card container. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Summary List component.
 *
 * Displays a list of key-value pairs, commonly used to summarise information
 * such as form answers in a "check your answers" page.
 *
 * @see https://design-system.service.gov.uk/components/summary-list/
 * @example
 * ```typescript
 * GovUKSummaryList({
 *   rows: [
 *     {
 *       key: { text: 'Name' },
 *       value: { text: 'John Smith' },
 *       actions: {
 *         items: [
 *           { href: '/change-name', text: 'Change', visuallyHiddenText: 'name' },
 *         ],
 *       },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With summary card wrapper
 * ```typescript
 * GovUKSummaryList({
 *   card: {
 *     title: { text: 'Personal details' },
 *     actions: {
 *       items: [
 *         { href: '/delete', text: 'Delete', visuallyHiddenText: 'personal details' },
 *       ],
 *     },
 *   },
 *   rows: [
 *     { key: { text: 'Name' }, value: { text: 'John Smith' } },
 *     { key: { text: 'Email' }, value: { text: 'john@example.com' } },
 *   ],
 * })
 * ```
 */
interface GovUKSummaryList extends BlockDefinition {
  /** The rows within the summary list. Each row contains a key-value pair. Required. */
  rows: ResolvableArray<SummaryListRow>;
  /**
   * Optional card configuration to wrap the summary list.
   * If provided, the summary list will be displayed inside a summary card
   * with an optional title and header actions.
   */
  card?: ResolvableObject<SummaryCard>;
  /** Additional CSS classes for the summary list dl element. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the summary list dl element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Summary List component.
 *
 * Displays a list of key-value pairs, commonly used to summarise information
 * such as form answers in a "check your answers" page.
 *
 * @see https://design-system.service.gov.uk/components/summary-list/
 * @example
 * ```typescript
 * GovUKSummaryList({
 *   rows: [
 *     {
 *       key: { text: 'Name' },
 *       value: { text: 'John Smith' },
 *       actions: {
 *         items: [
 *           { href: '/change-name', text: 'Change', visuallyHiddenText: 'name' },
 *         ],
 *       },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With summary card wrapper
 * ```typescript
 * GovUKSummaryList({
 *   card: {
 *     title: { text: 'Personal details' },
 *     actions: {
 *       items: [
 *         { href: '/delete', text: 'Delete', visuallyHiddenText: 'personal details' },
 *       ],
 *     },
 *   },
 *   rows: [
 *     { key: { text: 'Name' }, value: { text: 'John Smith' } },
 *     { key: { text: 'Email' }, value: { text: 'john@example.com' } },
 *   ],
 * })
 * ```
 */
declare const GovUKSummaryList: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKSummaryList, string>;
//#endregion
//#region forge-govuk-components/src/components/table/govukTable.d.ts
/**
 * Configuration for a table header cell.
 * Used in the `head` array to define column headers.
 */
interface TableHeadCell {
  /** Plain text content for the header cell. If `html` is provided, this will be ignored. */
  text?: ResolvableString;
  /** HTML content for the header cell. Takes precedence over `text`. */
  html?: ResolvableString;
  /** Specify format of the cell. Use "numeric" for right-aligned numeric data. */
  format?: ResolvableString;
  /** Additional CSS classes for the header cell. */
  classes?: ResolvableString;
  /** Number of columns this cell should span. */
  colspan?: ResolvableNumber;
  /** Number of rows this cell should span. */
  rowspan?: ResolvableNumber;
  /** Custom HTML attributes for the header cell element. */
  attributes?: Record<string, any>;
}
/**
 * Configuration for a table body cell.
 * Used in row arrays to define cell content.
 */
interface TableCell {
  /** Plain text content for the cell. If `html` or `blocks` is provided, this will be ignored. */
  text?: ResolvableString;
  /** HTML content for the cell. Takes precedence over `text`; ignored when `blocks` is provided. */
  html?: ResolvableString;
  /** Child blocks to render for the cell. Takes precedence over `text` and `html`. */
  blocks?: BlockDefinition[];
  /** Specify format of the cell. Use "numeric" for right-aligned numeric data. */
  format?: ResolvableString;
  /** Additional CSS classes for the cell. */
  classes?: ResolvableString;
  /** Number of columns this cell should span. */
  colspan?: ResolvableNumber;
  /** Number of rows this cell should span. */
  rowspan?: ResolvableNumber;
  /** Custom HTML attributes for the cell element. */
  attributes?: Record<string, any>;
}
/**
 * A row in the table, consisting of an array of cells.
 */
type TableRow = TableCell[];
/**
 * GOV.UK Table component.
 *
 * Displays data in a structured table format.
 * Supports headers, captions, numeric formatting, and row/column spans.
 *
 * @see https://design-system.service.gov.uk/components/table/
 * @example
 * ```typescript
 * GovUKTable({
 *   caption: 'Monthly savings',
 *   captionClasses: 'govuk-table__caption--m',
 *   head: [
 *     { text: 'Month' },
 *     { text: 'Amount', format: 'numeric' },
 *   ],
 *   rows: [
 *     [{ text: 'January' }, { text: '£85', format: 'numeric' }],
 *     [{ text: 'February' }, { text: '£165', format: 'numeric' }],
 *   ],
 * })
 * ```
 */
interface GovUKTable extends BlockDefinition {
  /** The rows within the table. Each row is an array of cells. Supports dynamic expressions. */
  rows: ResolvableArray<TableRow>;
  /** Table header cells. Renders a `<thead>` with a single header row. */
  head?: ResolvableArray<TableHeadCell>;
  /** Caption text displayed above the table. Useful for accessibility. */
  caption?: ResolvableString;
  /** CSS classes for the caption. Use GOV.UK typography classes like "govuk-table__caption--m". */
  captionClasses?: ResolvableString;
  /** If true, the first cell in each row will be rendered as a header (`<th>`) with row scope. */
  firstCellIsHeader?: ResolvableBoolean;
  /** Additional CSS classes for the table element. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the table element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Table component.
 *
 * Displays data in a structured table format.
 * Supports headers, captions, numeric formatting, and row/column spans.
 *
 * @see https://design-system.service.gov.uk/components/table/
 * @example
 * ```typescript
 * GovUKTable({
 *   caption: 'Monthly savings',
 *   captionClasses: 'govuk-table__caption--m',
 *   head: [
 *     { text: 'Month' },
 *     { text: 'Amount', format: 'numeric' },
 *   ],
 *   rows: [
 *     [{ text: 'January' }, { text: '£85', format: 'numeric' }],
 *     [{ text: 'February' }, { text: '£165', format: 'numeric' }],
 *   ],
 * })
 * ```
 */
declare const GovUKTable: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKTable, string>;
//#endregion
//#region forge-govuk-components/src/components/radio-input/govukRadioInput.d.ts
/**
 * GOV.UK Radio Input component.
 * Allows users to select a single option from a list of mutually exclusive choices.
 *
 * @see https://design-system.service.gov.uk/components/radios/
 * @example
 * ```typescript
 * GovUKRadioInput({
 *   code: 'contact_method',
 *   label: 'How would you like to be contacted?',
 *   items: [
 *     { value: 'email', text: 'Email' },
 *     { value: 'phone', text: 'Phone' },
 *     { value: 'text', text: 'Text message' },
 *   ],
 * })
 * ```
 */
interface GovUKRadioInput extends FieldBlockDefinition {
  /**
   * The label for the radio group.
   * When using fieldset, this becomes the legend text if no fieldset legend is specified.
   * @example 'How would you like to be contacted?'
   */
  label?: ResolvableString;
  /**
   * Can be used to add a fieldset to the radios component.
   * Provides semantic grouping and accessibility benefits for multiple related inputs.
   */
  fieldset?: {
    /**
     * Legend for the fieldset - describes the group of radio options.
     * If not provided, falls back to the `label` property.
     */
    legend?: {
      /** Text content of the legend */
      text?: ResolvableString;
      /** HTML content of the legend (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the legend */
      classes?: ResolvableString;
      /** Whether to render the legend as a page heading (wrapped in h1) */
      isPageHeading?: ResolvableBoolean;
    };
    /** Additional CSS classes for the fieldset wrapper */
    classes?: ResolvableString;
    /** HTML attributes to add to the fieldset */
    attributes?: Record<string, any>;
    /** Element IDs to add to the fieldset's aria-describedby attribute */
    describedBy?: ResolvableString;
  };
  /**
   * Can be used to add a hint to the radios component.
   * Provides additional context or instructions for the radio group.
   *
   * @example 'Select all that apply' // Simple hint
   * @example { html: 'Choose the <strong>most appropriate</strong> option' } // Rich HTML hint
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /**
   * Additional options for the form group containing the radios component.
   * Allows customization of the wrapper element and additional content.
   */
  formGroup?: {
    /**
     * Classes to add to the form group wrapper.
     * Useful for custom styling or indicating error states.
     */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /**
     * Content to add before all radio items within the radios component.
     * Useful for additional instructions or context.
     */
    beforeInputs?: {
      /** Text content to add before all radio items */
      text?: ResolvableString;
      /** HTML content to add before all radio items (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the before inputs content */
      classes?: ResolvableString;
    };
    /**
     * Content to add after all radio items within the radios component.
     * Useful for additional information or related actions.
     */
    afterInputs?: {
      /** Text content to add after all radio items */
      text?: ResolvableString;
      /** HTML content to add after all radio items (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the after inputs content */
      classes?: ResolvableString;
    };
  };
  /**
   * Optional prefix. This is used to prefix the `id` attribute for each radio input,
   * hint and error message, separated by `-`. Defaults to the `code` value.
   * @example 'contact-method' // Creates IDs like 'contact-method-email', 'contact-method-phone'
   */
  idPrefix?: ResolvableString;
  /**
   * Additional CSS classes to add to the radio container.
   * @example 'govuk-radios--inline' // Display radios horizontally
   * @example 'govuk-radios--small' // Smaller radio buttons
   */
  classes?: ResolvableString;
  /**
   * Additional HTML attributes (such as data attributes) to add to the radio input tag.
   * @example { 'data-module': 'govuk-radios' }
   */
  attributes?: Record<string, any>;
  /**
   * The radio items within the radios component.
   * Can include both radio options and dividers for visual separation.
   * Can also be an expression for dynamic items using the Iterator pattern.
   *
   * @example [
   *   { value: 'yes', text: 'Yes' },
   *   { value: 'no', text: 'No' },
   *   { divider: 'or' },
   *   { value: 'maybe', text: 'Not sure' }
   * ]
   *
   * @example
   * // Dynamic items using Iterator
   * Data('areas').each(Iterator.Map({ value: Item().path('value'), text: Item().path('text') }))
   */
  items: ResolvableArray<GovUKRadioInputItem | GovUKRadioInputDivider>;
}
/**
 * Individual radio option within a radio group.
 * Represents a single selectable choice with optional conditional reveals.
 */
interface GovUKRadioInputItem {
  /**
   * Value for the radio input. This is submitted with the form data when selected.
   * @example 'email'
   * @example 'phone'
   */
  value: ResolvableString;
  /**
   * Text to use within the radio item label.
   * If `html` is provided, this will be ignored.
   * @example 'Email'
   */
  text?: ResolvableString;
  /**
   * HTML to use within the radio item label.
   * Takes precedence over `text` if both are provided.
   * @example 'Email <span class="govuk-caption-m">Fastest response</span>'
   */
  html?: ResolvableString;
  /**
   * Specific ID attribute for the radio item.
   * If omitted, then `idPrefix` string will be applied with the value.
   * @example 'contact-email'
   */
  id?: ResolvableString;
  /**
   * Can be used to add a hint to each radio item within the radios component.
   * Provides additional context for individual options.
   * @example 'We'll send updates to this email address'
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /**
   * Whether the radio should be checked when the page loads.
   * Takes precedence over the top-level `value` option.
   * @example true // Pre-select this option
   */
  checked?: ResolvableBoolean;
  /**
   * If `true`, radio will be disabled and cannot be selected.
   * @example true // Disable this option
   */
  disabled?: ResolvableBoolean;
  /**
   * Additional HTML attributes (such as data attributes) to add to the radio input tag.
   * @example { 'data-aria-controls': 'conditional-content' }
   */
  attributes?: Record<string, any>;
  /**
   * Provide additional content to reveal when the radio is checked.
   * Useful for collecting additional information when specific options are selected.
   * @example someConditionalField // A field definition that appears when this radio is selected
   */
  block?: BlockDefinition | BlockDefinition[];
  /** Conditional visibility for this radio item */
  visibleWhen?: ResolvableBoolean;
}
/**
 * Divider element to separate radio options visually.
 * Useful for grouping related options or providing "or" separators.
 */
interface GovUKRadioInputDivider {
  /**
   * Divider text to separate radio items.
   * @example 'or'
   * @example 'Alternative options'
   */
  divider: ResolvableString;
  /** Conditional visibility for this divider */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Radio Input component.
 * Allows users to select a single option from a list of mutually exclusive choices.
 *
 * @see https://design-system.service.gov.uk/components/radios/
 * @example
 * ```typescript
 * GovUKRadioInput({
 *   code: 'contact_method',
 *   label: 'How would you like to be contacted?',
 *   items: [
 *     { value: 'email', text: 'Email' },
 *     { value: 'phone', text: 'Phone' },
 *     { value: 'text', text: 'Text message' },
 *   ],
 * })
 * ```
 */
declare const GovUKRadioInput: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKRadioInput, string>;
//#endregion
//#region forge-govuk-components/src/components/checkbox-input/govukCheckboxInput.d.ts
/**
 * GOV.UK Checkbox Input component.
 * Allows users to select multiple options from a list of choices.
 *
 * @see https://design-system.service.gov.uk/components/checkboxes/
 * @example
 * ```typescript
 * GovUKCheckboxInput({
 *   code: 'contact_methods',
 *   label: 'How would you like to be contacted?',
 *   hint: 'Select all that apply',
 *   items: [
 *     { value: 'email', text: 'Email' },
 *     { value: 'phone', text: 'Phone' },
 *     { value: 'text', text: 'Text message' },
 *   ],
 * })
 * ```
 */
interface GovUKCheckboxInput extends FieldBlockDefinition {
  /**
   * The label for the checkbox group.
   * When using fieldset, this becomes the legend text if no fieldset legend is specified.
   *
   * @example 'Which countries have you visited?'
   */
  label?: ResolvableString;
  /** Can be used to add a fieldset to the checkboxes component. */
  fieldset?: {
    /**
     * Legend for the fieldset - describes the group of checkbox options.
     * If not provided, falls back to the `label` property.
     */
    legend?: {
      /** Text content of the legend */
      text?: ResolvableString;
      /** HTML content of the legend (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the legend */
      classes?: ResolvableString;
      /** Whether to render the legend as a page heading (wrapped in h1) */
      isPageHeading?: ResolvableBoolean;
    };
    /** Additional CSS classes for the fieldset wrapper */
    classes?: ResolvableString;
    /** HTML attributes to add to the fieldset */
    attributes?: Record<string, any>;
    /** Element IDs to add to the fieldset's aria-describedby attribute */
    describedBy?: ResolvableString;
  };
  /**
   * Can be used to add a hint to the checkboxes component.
   * Provides additional context or instructions for the checkbox group.
   *
   * @example 'Select all that apply' // Simple hint
   * @example { html: 'Choose <strong>all relevant</strong> options' } // Rich HTML hint
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /** Additional options for the form group containing the checkboxes component. */
  formGroup?: {
    /** Classes to add to the form group wrapper. */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /** Content to add before all checkbox items within the checkboxes component. */
    beforeInputs?: {
      /** Text content to add before all checkbox items */
      text?: ResolvableString;
      /** HTML content to add before all checkbox items (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the before inputs content */
      classes?: ResolvableString;
    };
    /** Content to add after all checkbox items within the checkboxes component. */
    afterInputs?: {
      /** Text content to add after all checkbox items */
      text?: ResolvableString;
      /** HTML content to add after all checkbox items (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the after inputs content */
      classes?: ResolvableString;
    };
  };
  /**
   * Optional prefix. This is used to prefix the `id` attribute for each checkbox item input,
   * hint and error message, separated by `-`. Defaults to the `code` value.
   *
   * @example 'contact-methods' // Creates IDs like 'contact-methods-email', 'contact-methods-phone'
   */
  idPrefix?: ResolvableString;
  /**
   * Name attribute for all checkbox items.
   *
   * @example 'contact_preferences' // Form submission key
   */
  name?: ResolvableString;
  /**
   * One or more element IDs to add to the input `aria-describedby` attribute without a fieldset.
   * Used to provide additional descriptive information for screenreader users.
   *
   * @example 'contact-methods-guidance'
   */
  describedBy?: ResolvableString;
  /**
   * Additional CSS classes to add to the checkboxes container.
   *
   * @example 'govuk-checkboxes--small' // Smaller checkboxes
   */
  classes?: ResolvableString;
  /** Additional HTML attributes (such as data attributes) to add to the anchor tag. */
  attributes?: Record<string, any>;
  /**
   * The checkbox items within the checkboxes component.
   * Can include both checkbox options and dividers for visual separation.
   * Can also be an expression for dynamic items using the Iterator pattern.
   *
   * @example [
   *   { value: 'email', text: 'Email' },
   *   { value: 'phone', text: 'Phone' },
   *   { divider: 'or' },
   *   { value: 'none', text: 'None of the above', behaviour: 'exclusive' }
   * ]
   *
   * @example
   * // Dynamic items using Iterator
   * Data('areas').each(Iterator.Map({ value: Item().path('value'), text: Item().path('text') }))
   */
  items: ResolvableArray<GovUKCheckboxInputItem | GovUKCheckboxInputDivider>;
}
/**
 * Individual checkbox option within a checkbox group.
 * Represents a single selectable choice with optional conditional reveals and behaviors.
 */
interface GovUKCheckboxInputItem {
  /**
   * Value for the checkbox input. This is submitted with the form data when selected.
   *
   * @example 'Dog'
   */
  value: ResolvableString;
  /**
   * Text to use within the checkbox item label.
   * If `html` is provided, this will be ignored.
   *
   * @example 'Email'
   */
  text?: ResolvableString;
  /**
   * HTML to use within the checkbox item label.
   * Takes precedence over `text` if both are provided.
   *
   * @example 'Email <span class="govuk-caption-m">Fastest response</span>'
   */
  html?: ResolvableString;
  /**
   * Specific ID attribute for the checkbox item.
   * If omitted, then component global `idPrefix` option will be applied.
   *
   * @example 'contact-email'
   */
  id?: ResolvableString;
  /**
   * Can be used to add a hint to each checkbox item within the checkboxes component.
   * Provides additional context for individual options.
   *
   * @example 'We'll send updates to this email address'
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /**
   * Whether the checkbox should be checked when the page loads.
   * Takes precedence over the top-level `values` option.
   *
   * @example true // Pre-select this option
   */
  checked?: ResolvableBoolean;
  /**
   * If `true`, checkbox will be disabled and cannot be selected.
   *
   * @example true // Disable this option
   */
  disabled?: ResolvableBoolean;
  /**
   * If set to "exclusive", implements a 'None of these' type behavior via JavaScript.
   * When this checkbox is selected, all other checkboxes in the group are unchecked.
   * When any other checkbox is selected, this exclusive checkbox is unchecked.
   *
   * @example 'exclusive' // Typical for "None of the above" options
   */
  behaviour?: 'exclusive';
  /**
   * Additional HTML attributes (such as data attributes) to add to the checkbox input tag.
   */
  attributes?: Record<string, any>;
  /**
   * Subset of options for the label used by each checkbox item.
   */
  label?: {
    /** Additional CSS classes for the label tag */
    classes?: ResolvableString;
    /** HTML attributes to add to the label tag */
    attributes?: Record<string, any>;
  };
  /**
   * Provide additional content to reveal when the checkbox is checked.
   * Useful for collecting additional information when specific options are selected.
   *
   * @example someConditionalField // A field definition that appears when this checkbox is selected
   */
  block?: BlockDefinition | BlockDefinition[];
  /** Conditional visibility for this checkbox item */
  visibleWhen?: ResolvableBoolean;
}
/**
 * Divider element to separate checkbox options visually.
 */
interface GovUKCheckboxInputDivider {
  /**
   * Divider text to separate checkbox items.
   *
   * @example 'or'
   */
  divider: ResolvableString;
  /** Conditional visibility for this divider */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Checkbox Input component.
 * Allows users to select multiple options from a list of choices.
 *
 * @see https://design-system.service.gov.uk/components/checkboxes/
 * @example
 * ```typescript
 * GovUKCheckboxInput({
 *   code: 'contact_methods',
 *   label: 'How would you like to be contacted?',
 *   hint: 'Select all that apply',
 *   items: [
 *     { value: 'email', text: 'Email' },
 *     { value: 'phone', text: 'Phone' },
 *     { value: 'text', text: 'Text message' },
 *   ],
 * })
 * ```
 */
declare const GovUKCheckboxInput: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKCheckboxInput, string>;
//#endregion
//#region forge-govuk-components/src/components/date-input/govukDateInputVariants.d.ts
/**
 * The props shared by every GOV.UK Date Input variant.
 */
interface GovUKDateInputBase {
  /**
   * The label for the date input component.
   * When using fieldset, this becomes the legend text if no fieldset legend is specified.
   * @example 'Date of birth'
   * @example 'When did this happen?'
   */
  label?: ResolvableString;
  /** Fieldset wrapper for the date input component. */
  fieldset?: {
    /**
     * Legend for the fieldset - describes the group of inputs.
     * If not provided, falls back to the `label` property.
     */
    legend?: {
      /** Text content of the legend */
      text?: ResolvableString;
      /** HTML content of the legend (takes precedence over text) */
      html?: ResolvableString;
      /** Additional CSS classes for the legend */
      classes?: ResolvableString;
      /** Whether to render the legend as a page heading (wrapped in h1) */
      isPageHeading?: ResolvableBoolean;
    };
    /** Additional CSS classes for the fieldset wrapper */
    classes?: ResolvableString;
    /** HTML attributes to add to the fieldset */
    attributes?: Record<string, any>;
    /** Element IDs to add to the fieldsets aria-describedby attribute */
    describedBy?: ResolvableString;
  };
  /**
   * Hint text to provide additional guidance for the date input.
   *
   * @example 'For example, 31 3 1980' // Simple hint
   * @example { html: 'Enter the date as shown on your <strong>passport</strong>' } // Rich hint
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /** Additional options for the form group containing the date input component. */
  formGroup?: {
    /** Classes to add to the form group wrapper. */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /** Content to add before the date inputs. */
    beforeInputs?: {
      /** Text content to add before the inputs */
      text?: ResolvableString;
      /** HTML content to add before the inputs (takes precedence over text) */
      html?: ResolvableString;
    };
    /** Content to add after the date inputs */
    afterInputs?: {
      /** Text content to add after the inputs */
      text?: ResolvableString;
      /** HTML content to add after the inputs (takes precedence over text) */
      html?: ResolvableString;
    };
  };
  /**
   * The ID for the main date input component. Defaults to `code` if not provided.
   * Used to compose ID attributes for individual date fields (day, month, year).
   *
   * @example 'birthday' // Creates IDs like 'birthday-day', 'birthday-month', etc.
   */
  id?: ResolvableString;
  /**
   * Optional prefix for the name attributes of individual date inputs.
   * If not provided, uses `code`. Separated by '-' from the field names.
   *
   * @example 'start-date' // Creates names like 'start-date[day]', 'start-date[month]', etc.
   */
  namePrefix?: ResolvableString;
  /** Additional CSS classes to add to the date-input container. */
  classes?: ResolvableString;
  /** Additional HTML attributes (such as data attributes) to add to the date-input container. */
  attributes?: Record<string, any>;
}
/** GOV.UK Date Input capturing a full date - day, month and year. */
interface GovUKDateInputFull extends FieldBlockDefinition, GovUKDateInputBase {}
/** GOV.UK Date Input capturing a month and year only. */
interface GovUKDateInputYearMonth extends FieldBlockDefinition, GovUKDateInputBase {}
/** GOV.UK Date Input capturing a day and month only. */
interface GovUKDateInputMonthDay extends FieldBlockDefinition, GovUKDateInputBase {}
/**
 * Creates a GOV.UK Date Input field with day, month, and year.
 * Stores the value as an ISO date string in YYYY-MM-DD format.
 * Automatically adds formatters and parsers for the ISO conversion.
 *
 * @see https://design-system.service.gov.uk/components/date-input/
 * @example
 * ```typescript
 * GovUKDateInputFull({
 *   code: 'date_of_birth',
 *   label: 'Date of birth',
 *   hint: 'For example, 31 3 1980',
 * })
 * ```
 */
declare const GovUKDateInputFull: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKDateInputFull, string>;
/**
 * Creates a GOV.UK Date Input field with month and year only.
 * Stores the value as an ISO date string in YYYY-MM format.
 * Automatically adds formatters and parsers for the ISO conversion.
 * Useful for credit card expiry dates, employment periods, etc.
 *
 * @see https://design-system.service.gov.uk/components/date-input/
 * @example
 * ```typescript
 * GovUKDateInputYearMonth({
 *   code: 'card_expiry',
 *   label: 'Expiry date',
 *   hint: 'For example, 03 2025',
 * })
 * ```
 */
declare const GovUKDateInputYearMonth: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKDateInputYearMonth, string>;
/**
 * Creates a GOV.UK Date Input field with day and month only.
 * Stores the value as an ISO date string in MM-DD format.
 * Automatically adds formatters and parsers for the ISO conversion.
 * Useful for recurring dates like birthdays or anniversaries.
 *
 * @see https://design-system.service.gov.uk/components/date-input/
 * @example
 * ```typescript
 * GovUKDateInputMonthDay({
 *   code: 'anniversary',
 *   label: 'Anniversary date',
 *   hint: 'For example, 25 12',
 * })
 * ```
 */
declare const GovUKDateInputMonthDay: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKDateInputMonthDay, string>;
//#endregion
//#region forge-govuk-components/src/components/tabs/govukTabs.d.ts
/**
 * Panel content configuration for a tab.
 * The content that is displayed when the tab is selected.
 */
interface TabPanel {
  /** Plain text content for the panel. Required unless html or blocks is provided. */
  text?: ResolvableString;
  /** HTML content for the panel. Takes precedence over text. */
  html?: ResolvableString;
  /** Child blocks to render in the panel. Takes precedence over text/html. */
  blocks?: BlockDefinition[];
  /** Custom HTML attributes for the panel element. */
  attributes?: Record<string, any>;
}
/**
 * An individual tab within the tabs component.
 */
interface TabItem {
  /**
   * Specific ID attribute for the tab item.
   * This is used as the panel's ID and for the tab link's href.
   */
  id: ResolvableString;
  /** The text label displayed on the tab. Required. */
  label: ResolvableString;
  /** The content of the tab panel. Required. */
  panel: TabPanel;
  /** Custom HTML attributes for the tab element. */
  attributes?: Record<string, any>;
  /**
   * Conditional visibility for this tab. When the evaluated value is `false`,
   * the tab is omitted from rendering.
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Tabs component.
 *
 * Tabs allow users to navigate between related sections of content, displaying one
 * section at a time. Renders as a set of tab buttons that reveal associated content
 * panels. On mobile, tabs are displayed as a table of contents.
 *
 * @see https://design-system.service.gov.uk/components/tabs/
 * @example
 * ```typescript
 * GovUKTabs({
 *   id: 'my-tabs',
 *   items: [
 *     {
 *       id: 'past-day',
 *       label: 'Past day',
 *       panel: { text: 'Content for past day tab' },
 *     },
 *     {
 *       id: 'past-week',
 *       label: 'Past week',
 *       panel: { text: 'Content for past week tab' },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With child blocks as panel content
 * ```typescript
 * GovUKTabs({
 *   id: 'tabs-with-blocks',
 *   items: [
 *     {
 *       id: 'overview',
 *       label: 'Overview',
 *       panel: {
 *         blocks: [
 *           GovUKInsetText({ text: 'Important overview information' }),
 *           GovUKWarningText({ text: 'Warning message' }),
 *         ],
 *       },
 *     },
 *   ],
 * })
 * ```
 */
interface GovUKTabs extends BlockDefinition {
  /**
   * Unique ID for the tabs component.
   * This is used for the main component and to compose the ID attribute for each item.
   */
  id: ResolvableString;
  /**
   * Title for the tabs table of contents.
   * Displayed on mobile where tabs become a table of contents.
   * Defaults to "Contents".
   */
  title?: ResolvableString;
  /** The individual tabs within the tabs component. Required. */
  items: ResolvableArray<TabItem>;
  /** Additional CSS classes for the tabs element. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the tabs element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Tabs component.
 *
 * Tabs allow users to navigate between related sections of content, displaying one
 * section at a time. Renders as a set of tab buttons that reveal associated content
 * panels. On mobile, tabs are displayed as a table of contents.
 *
 * @see https://design-system.service.gov.uk/components/tabs/
 * @example
 * ```typescript
 * GovUKTabs({
 *   id: 'my-tabs',
 *   items: [
 *     {
 *       id: 'past-day',
 *       label: 'Past day',
 *       panel: { text: 'Content for past day tab' },
 *     },
 *     {
 *       id: 'past-week',
 *       label: 'Past week',
 *       panel: { text: 'Content for past week tab' },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With child blocks as panel content
 * ```typescript
 * GovUKTabs({
 *   id: 'tabs-with-blocks',
 *   items: [
 *     {
 *       id: 'overview',
 *       label: 'Overview',
 *       panel: {
 *         blocks: [
 *           GovUKInsetText({ text: 'Important overview information' }),
 *           GovUKWarningText({ text: 'Warning message' }),
 *         ],
 *       },
 *     },
 *   ],
 * })
 * ```
 */
declare const GovUKTabs: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKTabs, string>;
//#endregion
//#region forge-govuk-components/src/components/task-list/govukTaskList.d.ts
/**
 * Tag configuration for task status.
 * Renders a colored tag to indicate task completion status.
 *
 * @see https://design-system.service.gov.uk/components/tag/
 */
interface TaskListStatusTag {
  /** Plain text content for the tag. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the tag. Takes precedence over text. */
  html?: ResolvableString;
  /**
   * Additional CSS classes for the tag.
   * Use modifier classes like `govuk-tag--blue`, `govuk-tag--grey` to change color.
   */
  classes?: ResolvableString;
  /** Custom HTML attributes for the tag element. */
  attributes?: Record<string, any>;
}
/**
 * Status configuration for a task list item.
 * Can display either a tag (for statuses like "Completed", "In progress")
 * or plain text/HTML (for statuses like "Cannot start yet").
 */
interface TaskListStatus {
  /**
   * Tag configuration for the status.
   * Use this for statuses that should be visually prominent.
   * If provided, text and html are ignored.
   */
  tag?: ResolvableObject<TaskListStatusTag>;
  /**
   * Plain text for the status.
   * Used when a simpler, non-tag status is needed.
   * Ignored if tag or html is provided.
   */
  text?: ResolvableString;
  /**
   * HTML content for the status.
   * Used when custom HTML is needed for the status.
   * Ignored if tag is provided.
   */
  html?: ResolvableString;
  /** Additional CSS classes for the status container. */
  classes?: ResolvableString;
}
/**
 * Title configuration for a task list item.
 * Contains the main clickable text that describes the task.
 */
interface TaskListTitle {
  /** Plain text content for the title. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the title. Takes precedence over text. */
  html?: ResolvableString;
  /** Additional CSS classes for the title wrapper. */
  classes?: ResolvableString;
}
/**
 * Hint configuration for a task list item.
 * Provides additional descriptive text below the title.
 */
interface TaskListHint {
  /** Plain text content for the hint. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the hint. Takes precedence over text. */
  html?: ResolvableString;
}
/**
 * A single item in the task list.
 * Represents one task with its title, optional hint, status, and link.
 */
interface TaskListItem {
  /**
   * The main title for the task.
   * This is the primary clickable text that describes what the task involves.
   */
  title: TaskListTitle;
  /**
   * Optional hint text displayed below the title.
   * Use to provide additional context about the task.
   */
  hint?: TaskListHint;
  /**
   * The status of the task.
   * Displays on the right side of the task row.
   */
  status: TaskListStatus;
  /**
   * The URL to navigate to when the task title is clicked.
   * If not provided, the title is rendered as plain text rather than a link.
   */
  href?: ResolvableString;
  /** Additional CSS classes for the item div. */
  classes?: ResolvableString;
  /**
   * Conditional visibility for this task. When the evaluated value is `false`,
   * the task is omitted from rendering. Defaults to showing the task.
   *
   * @example Answer('applicationType').match(Condition.Equals('business'))
   */
  visibleWhen?: ResolvableBoolean;
}
/**
 * GOV.UK Task List component.
 *
 * Displays a list of tasks with their completion status.
 * Commonly used to show users a list of tasks they need to complete
 * as part of a multi-step process, such as applying for something or registering.
 *
 * @see https://design-system.service.gov.uk/components/task-list/
 * @example
 * ```typescript
 * GovUKTaskList({
 *   items: [
 *     {
 *       title: { text: 'Company information' },
 *       href: '/company-info',
 *       status: {
 *         tag: { text: 'Completed', classes: 'govuk-tag--blue' },
 *       },
 *     },
 *     {
 *       title: { text: 'Contact details' },
 *       hint: { text: 'Include email and phone number' },
 *       href: '/contact-details',
 *       status: {
 *         tag: { text: 'In progress', classes: 'govuk-tag--blue' },
 *       },
 *     },
 *     {
 *       title: { text: 'Submit application' },
 *       status: {
 *         text: 'Cannot start yet',
 *       },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With custom id prefix
 * ```typescript
 * GovUKTaskList({
 *   idPrefix: 'registration',
 *   items: [
 *     {
 *       title: { text: 'Personal details' },
 *       href: '/personal-details',
 *       status: { tag: { text: 'Completed' } },
 *     },
 *   ],
 * })
 * ```
 */
interface GovUKTaskList extends BlockDefinition {
  /** The items within the task list. Each item represents a single task. Required. */
  items: ResolvableArray<TaskListItem>;
  /** Additional CSS classes for the task list ul element. */
  classes?: ResolvableString;
  /** Custom HTML attributes for the task list ul element. */
  attributes?: Record<string, any>;
  /**
   * Optional prefix for id attributes.
   * Used to prefix the id attribute for task list item tags and hints.
   * Defaults to "task-list".
   */
  idPrefix?: ResolvableString;
}
/**
 * GOV.UK Task List component.
 *
 * Displays a list of tasks with their completion status.
 * Commonly used to show users a list of tasks they need to complete
 * as part of a multi-step process, such as applying for something or registering.
 *
 * @see https://design-system.service.gov.uk/components/task-list/
 * @example
 * ```typescript
 * GovUKTaskList({
 *   items: [
 *     {
 *       title: { text: 'Company information' },
 *       href: '/company-info',
 *       status: {
 *         tag: { text: 'Completed', classes: 'govuk-tag--blue' },
 *       },
 *     },
 *     {
 *       title: { text: 'Contact details' },
 *       hint: { text: 'Include email and phone number' },
 *       href: '/contact-details',
 *       status: {
 *         tag: { text: 'In progress', classes: 'govuk-tag--blue' },
 *       },
 *     },
 *     {
 *       title: { text: 'Submit application' },
 *       status: {
 *         text: 'Cannot start yet',
 *       },
 *     },
 *   ],
 * })
 * ```
 *
 * @example With custom id prefix
 * ```typescript
 * GovUKTaskList({
 *   idPrefix: 'registration',
 *   items: [
 *     {
 *       title: { text: 'Personal details' },
 *       href: '/personal-details',
 *       status: { tag: { text: 'Completed' } },
 *     },
 *   ],
 * })
 * ```
 */
declare const GovUKTaskList: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKTaskList, string>;
//#endregion
//#region forge-govuk-components/src/components/back-link/govukBackLink.d.ts
/**
 * GOV.UK Back Link component.
 *
 * Use this to help users go back to the previous page in a multi-page transaction.
 * Should be placed at the top of the page, before the main content.
 *
 * @see https://design-system.service.gov.uk/components/back-link/
 * @example
 * ```typescript
 * GovUKBackLink({
 *   href: '/previous-page',
 * })
 *
 * // With custom text
 * GovUKBackLink({
 *   href: '/dashboard',
 *   text: 'Return to dashboard',
 * })
 * ```
 */
interface GovUKBackLink extends BlockDefinition {
  /**
   * The value of the link's `href` attribute.
   * This is the URL that the user will be taken to when they click the back link.
   */
  href: ResolvableString;
  /**
   * Plain text content for the back link.
   * Defaults to "Back" if neither `text` nor `html` is provided.
   * If `html` is provided, this option will be ignored.
   */
  text?: ResolvableString;
  /**
   * HTML content for the back link.
   * Takes precedence over `text` if both are provided.
   * Defaults to "Back" if neither `text` nor `html` is provided.
   */
  html?: ResolvableString;
  /**
   * Additional CSS classes to add to the anchor tag.
   * Use this to apply custom styling or modifier classes.
   */
  classes?: ResolvableString;
  /**
   * HTML attributes (for example data attributes) to add to the anchor tag.
   * Useful for adding custom data attributes or ARIA attributes.
   */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Back Link component.
 *
 * Use this to help users go back to the previous page in a multi-page transaction.
 * Should be placed at the top of the page, before the main content.
 *
 * @see https://design-system.service.gov.uk/components/back-link/
 * @example
 * ```typescript
 * GovUKBackLink({
 *   href: '/previous-page',
 * })
 *
 * // With custom text
 * GovUKBackLink({
 *   href: '/dashboard',
 *   text: 'Return to dashboard',
 * })
 * ```
 */
declare const GovUKBackLink: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKBackLink, string>;
//#endregion
//#region forge-govuk-components/src/components/body/govukBody.d.ts
type BodySize = 'l' | 's';
/**
 * GOV.UK styled paragraph.
 *
 * @see https://design-system.service.gov.uk/styles/paragraphs/
 * @example
 * ```typescript
 * GovUKBody({ text: 'Standard paragraph text' })
 * GovUKBody({ text: Format('Hello %1', name) })
 * GovUKBody({ text: 'Introductory lead paragraph', size: 'l' })
 * GovUKBody({ text: 'Small print text', size: 's' })
 * ```
 */
interface GovUKBody extends BlockDefinition {
  /**
   * Text content for the paragraph. Supports dynamic expressions.
   *
   * **Rendered as raw HTML without sanitization** - escape untrusted data with
   * `Transformer.String.EscapeHtml()` before interpolating it.
   */
  text: ResolvableString;
  /** Paragraph size variant. 'l' for lead paragraph (24px), 's' for small (16px). Omit for default (19px). */
  size?: BodySize;
  /** Additional CSS classes to append to the paragraph. */
  classes?: ResolvableString;
  /** HTML attributes to add to the paragraph element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK styled paragraph.
 *
 * @see https://design-system.service.gov.uk/styles/paragraphs/
 * @example
 * ```typescript
 * GovUKBody({ text: 'Standard paragraph text' })
 * GovUKBody({ text: 'Introductory lead paragraph', size: 'l' })
 * ```
 */
declare const GovUKBody: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKBody, string>;
//#endregion
//#region forge-govuk-components/src/components/button/govukButton.d.ts
/**
 * GOV.UK Button component.
 *
 * Creates a button for form submission. Renders as a `<button>` element with form
 * submission capabilities.
 *
 * @see https://design-system.service.gov.uk/components/button/
 * @example
 * ```typescript
 * GovUKButton({
 *   text: 'Save and continue',
 *   buttonType: 'submit',
 *   name: 'action',
 *   value: 'save',
 * })
 * ```
 */
interface GovUKButton extends BlockDefinition {
  /** Text content for the button */
  text?: ResolvableString;
  /** HTML content for the button */
  html?: ResolvableString;
  /** Additional CSS classes */
  classes?: ResolvableString;
  /** Custom HTML attributes */
  attributes?: Record<string, any>;
  /** Style as start/call-to-action button */
  isStartButton?: ResolvableBoolean;
  /** Button ID */
  id?: ResolvableString;
  /** Name attribute for form submission, defaults to 'action' */
  name?: ResolvableString;
  /** Type attribute for button/input elements - defaults to 'submit' */
  buttonType?: 'button' | 'submit' | 'reset';
  /** Value attribute for button elements */
  value?: ResolvableString;
  /** Whether the button is disabled */
  disabled?: ResolvableBoolean;
  /** Prevent double-click submission */
  preventDoubleClick?: ResolvableBoolean;
}
/**
 * GOV.UK Link Button component.
 *
 * Creates a button for navigation. Renders as an `<a>` element styled as a button.
 *
 * @see https://design-system.service.gov.uk/components/button/
 * @example
 * ```typescript
 * GovUKLinkButton({
 *   text: 'Start now',
 *   href: '/application/start',
 *   isStartButton: true,
 * })
 * ```
 */
interface GovUKLinkButton extends BlockDefinition {
  /** Text content for the button */
  text?: ResolvableString;
  /** HTML content for the button */
  html?: ResolvableString;
  /** Additional CSS classes */
  classes?: ResolvableString;
  /** Custom HTML attributes */
  attributes?: Record<string, any>;
  /** Style as start/call-to-action button */
  isStartButton?: ResolvableBoolean;
  /** Button ID */
  id?: ResolvableString;
  /** URL for the link */
  href: ResolvableString;
}
/**
 * GOV.UK Button component.
 *
 * Creates a button for form submission. Renders as a `<button>` element with form
 * submission capabilities.
 *
 * @see https://design-system.service.gov.uk/components/button/
 * @example
 * ```typescript
 * GovUKButton({
 *   text: 'Save and continue',
 *   buttonType: 'submit',
 *   name: 'action',
 *   value: 'save',
 * })
 * ```
 */
declare const GovUKButton: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKButton, string>;
/**
 * GOV.UK Link Button component.
 *
 * Creates a button for navigation. Renders as an `<a>` element styled as a button.
 *
 * @see https://design-system.service.gov.uk/components/button/
 * @example
 * ```typescript
 * GovUKLinkButton({
 *   text: 'Start now',
 *   href: '/application/start',
 *   isStartButton: true,
 * })
 * ```
 */
declare const GovUKLinkButton: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKLinkButton, string>;
//#endregion
//#region forge-govuk-components/src/components/button-group/govukButtonGroup.d.ts
/**
 * Wraps child blocks in a GOV.UK button group layout.
 *
 * @see https://design-system.service.gov.uk/components/button/#grouping-buttons
 * @example
 * ```typescript
 * GovUKButtonGroup({
 *   buttons: [
 *     GovUKButton({ text: 'Save and continue' }),
 *     GovUKButton({ text: 'Cancel', classes: 'govuk-button--secondary' }),
 *   ],
 * })
 * ```
 */
interface GovUKButtonGroup extends BlockDefinition {
  /** The buttons/links to render inside the group. */
  buttons: BlockDefinition[];
  /** Additional CSS classes to append to the button group. */
  classes?: ResolvableString;
  /** HTML attributes to add to the wrapper element. */
  attributes?: Record<string, any>;
}
/**
 * Wraps child blocks in a GOV.UK button group layout.
 *
 * @see https://design-system.service.gov.uk/components/button/#grouping-buttons
 * @example
 * ```typescript
 * GovUKButtonGroup({
 *   buttons: [GovUKButton({ text: 'Save and continue' })],
 * })
 * ```
 */
declare const GovUKButtonGroup: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKButtonGroup, string>;
//#endregion
//#region forge-govuk-components/src/components/grid-row/govukGridRow.d.ts
type GridColumnWidth = 'full' | 'one-half' | 'one-third' | 'two-thirds' | 'one-quarter' | 'three-quarters' | 'one-sixth';
interface GovUKGridColumn {
  width: GridColumnWidth;
  blocks: BlockDefinition[];
}
/**
 * Wraps child blocks in a GOV.UK grid row with responsive column widths.
 *
 * @see https://design-system.service.gov.uk/styles/layout/#grid-system
 * @example
 * ```typescript
 * GovUKGridRow({
 *   columns: [
 *     { width: 'one-quarter', blocks: [labelBlock] },
 *     { width: 'two-thirds', blocks: [inputField] },
 *     { width: 'one-sixth', blocks: [removeButton] },
 *   ],
 * })
 * ```
 */
interface GovUKGridRow extends BlockDefinition {
  /** Column definitions with width and child blocks. */
  columns: ResolvableArray<GovUKGridColumn>;
  /** Additional CSS classes to append to the row. */
  classes?: ResolvableString;
  /** HTML attributes to add to the row element. */
  attributes?: Record<string, any>;
}
/**
 * Wraps child blocks in a GOV.UK grid row with responsive column widths.
 *
 * @see https://design-system.service.gov.uk/styles/layout/#grid-system
 * @example
 * ```typescript
 * GovUKGridRow({
 *   columns: [{ width: 'one-half', blocks: [textInput] }],
 * })
 * ```
 */
declare const GovUKGridRow: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKGridRow, string>;
//#endregion
//#region forge-govuk-components/src/components/heading/govukHeading.d.ts
type HeadingSize = 'xl' | 'l' | 'm' | 's';
type HeadingLevel = 1 | 2 | 3 | 4;
/**
 * GOV.UK heading with an optional caption.
 * Automatically pairs caption size to heading size (e.g. govuk-caption-l with govuk-heading-l).
 *
 * @see https://design-system.service.gov.uk/styles/headings/
 * @example
 * ```typescript
 * GovUKHeading({ text: 'Page title' })
 * GovUKHeading({ text: 'Page title', size: 'xl', caption: 'Section name' })
 * GovUKHeading({ text: Format('Goal: %1', goalTitle), size: 'm', level: 2 })
 * ```
 */
interface GovUKHeading extends BlockDefinition {
  /**
   * Heading text content. Supports dynamic expressions.
   *
   * **Rendered as raw HTML without sanitization** - escape untrusted data with
   * `Transformer.String.EscapeHtml()` before interpolating it.
   */
  text: ResolvableString;
  /** Visual size of the heading. Defaults to 'l'. */
  size?: HeadingSize;
  /** HTML heading level (1-4). Defaults based on size: xl/l→h1, m→h2, s→h3. */
  level?: HeadingLevel;
  /**
   * Optional caption displayed above the heading. Matches the heading size class automatically.
   *
   * **Rendered as raw HTML without sanitization** - escape untrusted data with
   * `Transformer.String.EscapeHtml()` before interpolating it.
   */
  caption?: ResolvableString;
  /** Additional CSS classes to append to the heading. */
  classes?: ResolvableString;
  /** HTML attributes to add to the heading element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK heading with an optional caption.
 * Automatically pairs caption size to heading size (e.g. govuk-caption-l with govuk-heading-l).
 *
 * @see https://design-system.service.gov.uk/styles/headings/
 * @example
 * ```typescript
 * GovUKHeading({ text: 'Page title' })
 * GovUKHeading({ text: 'Page title', size: 'xl', caption: 'Section name' })
 * ```
 */
declare const GovUKHeading: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKHeading, string>;
//#endregion
//#region forge-govuk-components/src/components/list/govukList.d.ts
type ListType = 'bullet' | 'number';
/**
 * GOV.UK styled list. Items can be strings, child blocks, or a mix of the two.
 *
 * @see https://design-system.service.gov.uk/styles/lists/
 * @example
 * ```typescript
 * GovUKList({ items: Data('suggestions'), style: 'bullet' })
 * GovUKList({ items: Data('steps'), style: 'number', spaced: true })
 * GovUKList({
 *   items: [
 *     GovUKBody({ text: 'A paragraph item' }),
 *     HtmlBlock({ tag: 'a', attributes: { href: '/help' }, content: 'A link item' }),
 *   ],
 * })
 * ```
 */
interface GovUKList extends BlockDefinition {
  /**
   * The list items - strings, child blocks, or a dynamic expression evaluating to an array.
   *
   * **String items are rendered as raw HTML without sanitization** - escape untrusted data
   * with `Transformer.String.EscapeHtml()` before interpolating it.
   */
  items: ResolvableArray<ResolvableString | BlockDefinition>;
  /** List style. 'bullet' for unordered, 'number' for ordered. Omit for plain list. */
  style?: ListType;
  /** Whether to add extra spacing between list items. */
  spaced?: ResolvableBoolean;
  /** Additional CSS classes to append to the list. */
  classes?: ResolvableString;
  /** HTML attributes to add to the list element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK styled list. Items can be strings, child blocks, or a mix of the two.
 *
 * @see https://design-system.service.gov.uk/styles/lists/
 * @example
 * ```typescript
 * GovUKList({ items: Data('suggestions'), style: 'bullet' })
 * GovUKList({ items: ['First step', GovUKBody({ text: 'Second step' })], style: 'number' })
 * ```
 */
declare const GovUKList: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKList, string>;
//#endregion
//#region forge-govuk-components/src/components/section-break/govukSectionBreak.d.ts
type SectionBreakSize = 'xl' | 'l' | 'm';
/**
 * GOV.UK section break (thematic `<hr>` between content sections).
 *
 * @see https://design-system.service.gov.uk/styles/section-break/
 * @example
 * ```typescript
 * GovUKSectionBreak({ size: 'l', visible: true })
 * GovUKSectionBreak({ size: 'xl' })
 * GovUKSectionBreak()
 * ```
 */
interface GovUKSectionBreak extends BlockDefinition {
  /** Size of the section break margin. Omit for default (smallest) spacing. */
  size?: SectionBreakSize;
  /** Whether to show a visible horizontal rule. Defaults to false (spacing only). */
  visible?: ResolvableBoolean;
  /** Additional CSS classes to append to the section break. */
  classes?: ResolvableString;
  /** HTML attributes to add to the hr element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK section break (thematic `<hr>` between content sections).
 *
 * @see https://design-system.service.gov.uk/styles/section-break/
 * @example
 * ```typescript
 * GovUKSectionBreak({ size: 'l', visible: true })
 * GovUKSectionBreak()
 * ```
 */
declare const GovUKSectionBreak: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKSectionBreak, string>;
//#endregion
//#region forge-govuk-components/src/components/text-input/govukTextInput.d.ts
/**
 * GOV.UK Text Input component.
 * A single-line text input component following the GOV.UK Design System patterns.
 *
 * @see https://design-system.service.gov.uk/components/text-input/
 * @example
 * ```typescript
 * GovUKTextInput({
 *   code: 'email',
 *   label: 'Email address',
 *   hint: 'We will only use this to contact you about your application',
 *   autocomplete: 'email',
 * })
 * ```
 */
interface GovUKTextInput extends FieldBlockDefinition {
  /**
   * The ID of the input. Defaults to the value of `code` if not provided.
   * @example 'user-email'
   */
  id?: ResolvableString;
  /**
   * The label used by the text input component.
   * Can be a simple string or a complex object with additional properties.
   *
   * @example 'Full name' // Simple string label
   * @example { text: 'Email address', classes: 'govuk-label--l' } // Object with styling
   */
  label: ResolvableString | {
    /** Text content of the label */
    text?: ResolvableString;
    /** HTML content of the label (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the label */
    classes?: ResolvableString;
    /** For attribute - automatically set if not provided */
    for?: ResolvableString;
    /** Whether to render the label as a page heading (wrapped in h1) */
    isPageHeading?: ResolvableBoolean;
    /** Additional HTML attributes for the label */
    attributes?: Record<string, any>;
  };
  /**
   * Can be used to add a hint to the text input component.
   * Provides additional context or instructions for the user.
   *
   * @example 'For example, john.smith@example.com' // Simple hint
   * @example { html: 'We'll only use this to send you <strong>important updates</strong>' } // Rich HTML hint
   */
  hint?: ResolvableString | {
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /**
   * Type of input control to render. Defaults to "text".
   * Different types provide specialized keyboard layouts and validation on mobile devices.
   *
   * @example 'email' // Email keyboard on mobile
   * @example 'password' // Masked input
   * @example 'tel' // Numeric keyboard for phone numbers
   */
  inputType?: 'text' | 'email' | 'url' | 'tel' | 'password' | 'number';
  /**
   * Optional value for the inputmode attribute.
   * Provides hints about the expected input type to optimize virtual keyboards.
   *
   * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
   * @example 'email' // Email-optimized keyboard
   * @example 'decimal' // Numeric keyboard with decimal point
   * @example 'search' // Search-optimized keyboard
   */
  inputMode?: 'text' | 'decimal' | 'search' | 'email' | 'url' | 'numeric';
  /**
   * If `true`, input will be disabled and cannot be edited by the user.
   * @example true // Disable the input
   */
  disabled?: ResolvableBoolean;
  /**
   * Attribute to meet WCAG success criterion 1.3.5: Identify input purpose.
   * Helps browsers provide appropriate autofill suggestions.
   *
   * @see https://www.w3.org/WAI/WCAG22/Understanding/identify-input-purpose.html
   * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill
   * @example 'email' // For email address fields
   * @example 'given-name' // For first name fields
   * @example 'off' // Disable autocomplete
   */
  autocomplete?: ResolvableString;
  /**
   * One or more element IDs to add to the `aria-describedby` attribute.
   * Used to provide additional descriptive information for screenreader users.
   *
   * @example 'email-requirements'
   */
  describedBy?: ResolvableString;
  /**
   * Attribute to provide a regular expression pattern for input validation.
   * Used to match allowed character combinations for the input value.
   *
   * @see https://html.spec.whatwg.org/multipage/input.html#the-pattern-attribute
   * @example '[0-9]*' // Only allow digits
   * @example '[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}' // Basic email pattern
   */
  pattern?: ResolvableString;
  /**
   * Optional field to enable or disable the spellcheck attribute on the input.
   * When not specified, browsers will use their default behavior.
   * @example true // Enable spellcheck
   * @example false // Disable spellcheck (useful for usernames, codes, etc.)
   */
  spellcheck?: ResolvableBoolean;
  /**
   * Optional field to enable or disable autocapitalisation of user input.
   *
   * @see https://html.spec.whatwg.org/multipage/interaction.html#autocapitalization
   * @example 'words' // Capitalize first letter of each word
   * @example 'sentences' // Capitalize first letter of each sentence
   * @example 'off' // Disable autocapitalization
   */
  autocapitalize?: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
  /**
   * Can be used to add a prefix to the text input component.
   * Useful for currency symbols, units, or other contextual indicators.
   *
   * @example { text: '£' } // Currency prefix
   * @example { html: '<span aria-hidden="true">@</span>' } // Username prefix
   */
  prefix?: {
    /** Text content of the prefix (takes precedence over html if both provided) */
    text?: ResolvableString;
    /** HTML content of the prefix */
    html?: ResolvableString;
    /** Additional CSS classes for the prefix */
    classes?: ResolvableString;
    /** Additional HTML attributes for the prefix element */
    attributes?: Record<string, any>;
  };
  /**
   * Can be used to add a suffix to the text input component.
   * Useful for units of measurement, file extensions, or other contextual indicators.
   *
   * @example { text: 'kg' } // Weight unit suffix
   * @example { text: '.gov.uk' } // Domain suffix
   */
  suffix?: {
    /** Text content of the suffix */
    text?: ResolvableString;
    /** HTML content of the suffix (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the suffix element */
    classes?: ResolvableString;
    /** Additional HTML attributes for the suffix element */
    attributes?: Record<string, any>;
  };
  /**
   * Additional options for the form group containing the text input component.
   * Allows customization of the wrapper element and additional content.
   */
  formGroup?: {
    /**
     * Classes to add to the form group wrapper.
     * Useful for custom styling or indicating error states.
     */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /**
     * Content to add before the input element.
     * Useful for additional instructions or related content.
     */
    beforeInput?: {
      /** Text content to add before the input */
      text?: ResolvableString;
      /** HTML content to add before the input (takes precedence over text) */
      html?: ResolvableString;
    };
    /**
     * Content to add after the input element.
     * Useful for format examples or related actions.
     */
    afterInput?: {
      /** Text content to add after the input */
      text?: ResolvableString;
      /** HTML content to add after the input (takes precedence over text) */
      html?: ResolvableString;
    };
  };
  /**
   * If any of prefix, suffix, formGroup.beforeInput or formGroup.afterInput have a value,
   * a wrapping element is added around the input and inserted content.
   * This allows customization of that wrapping element.
   */
  inputWrapper?: {
    /** Additional CSS classes for the input wrapper element */
    classes?: ResolvableString;
    /** Additional HTML attributes for the input wrapper element */
    attributes?: Record<string, any>;
  };
  /**
   * Additional CSS classes to add to the input element.
   * @example 'govuk-input--width-20' // Fixed width input
   * @example 'js-character-count' // For character counting functionality
   */
  classes?: ResolvableString;
  /**
   * Additional HTML attributes (such as data attributes) to add to the input element.
   * @example { 'data-module': 'character-count', 'data-maxlength': '100' }
   * @example { 'aria-describedby': 'additional-help-text' }
   */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Text Input component.
 * A single-line text input component following the GOV.UK Design System patterns.
 *
 * @see https://design-system.service.gov.uk/components/text-input/
 * @example
 * ```typescript
 * GovUKTextInput({
 *   code: 'email',
 *   label: 'Email address',
 *   hint: 'We will only use this to contact you about your application',
 *   autocomplete: 'email',
 * })
 * ```
 */
declare const GovUKTextInput: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKTextInput, string>;
//#endregion
//#region forge-govuk-components/src/components/password-input/govukPasswordInput.d.ts
/**
 * GOV.UK Password Input component.
 * A password input component with a show/hide toggle following the GOV.UK Design System patterns.
 *
 * The password input component allows users to enter a password with a toggle button
 * to show or hide the password text. This helps users check they have typed their
 * password correctly, particularly on mobile devices.
 *
 * @see https://design-system.service.gov.uk/components/password-input/
 * @example
 * ```typescript
 * GovUKPasswordInput({
 *   code: 'password',
 *   label: 'Password',
 *   hint: 'Your password must be at least 8 characters',
 *   autocomplete: 'current-password',
 * })
 * ```
 * @example
 * ```typescript
 * // For new password creation (e.g., registration)
 * GovUKPasswordInput({
 *   code: 'new-password',
 *   label: { text: 'Create a password', isPageHeading: true },
 *   hint: 'Your password must contain at least 8 characters, a number, and a special character',
 *   autocomplete: 'new-password',
 * })
 * ```
 */
interface GovUKPasswordInput extends FieldBlockDefinition {
  /**
   * The ID of the input. Defaults to the value of `code` if not provided.
   * @example 'user-password'
   */
  id?: ResolvableString;
  /**
   * The label used by the password input component.
   * Can be a simple string or a complex object with additional properties.
   *
   * @example 'Password' // Simple string label
   * @example { text: 'Create a password', classes: 'govuk-label--l' } // Object with styling
   */
  label: ResolvableString | {
    /** Text content of the label */
    text?: ResolvableString;
    /** HTML content of the label (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the label */
    classes?: ResolvableString;
    /** For attribute - automatically set if not provided */
    for?: ResolvableString;
    /** Whether to render the label as a page heading (wrapped in h1) */
    isPageHeading?: ResolvableBoolean;
    /** Additional HTML attributes for the label */
    attributes?: Record<string, any>;
  };
  /**
   * Can be used to add a hint to the password input component.
   * Provides additional context or instructions for the user.
   *
   * @example 'Your password must be at least 8 characters' // Simple hint
   * @example { html: 'It must contain at least one <strong>number</strong>' } // Rich HTML hint
   */
  hint?: ResolvableString | {
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /**
   * If `true`, input will be disabled and cannot be edited by the user.
   * @example true // Disable the input
   */
  disabled?: ResolvableBoolean;
  /**
   * Attribute to meet WCAG success criterion 1.3.5: Identify input purpose.
   * Helps browsers provide appropriate autofill suggestions.
   * Defaults to 'current-password' if not specified.
   *
   * @see https://www.w3.org/WAI/WCAG22/Understanding/identify-input-purpose.html
   * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill
   * @example 'current-password' // For login forms
   * @example 'new-password' // For registration or password change forms
   */
  autocomplete?: ResolvableString;
  /**
   * One or more element IDs to add to the `aria-describedby` attribute.
   * Used to provide additional descriptive information for screenreader users.
   *
   * @example 'password-requirements'
   */
  describedBy?: ResolvableString;
  /**
   * Additional options for the form group containing the password input component.
   * Allows customization of the wrapper element and additional content.
   */
  formGroup?: {
    /**
     * Classes to add to the form group wrapper.
     * Useful for custom styling or indicating error states.
     */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /**
     * Content to add before the input element.
     * Useful for additional instructions or related content.
     */
    beforeInput?: {
      /** Text content to add before the input */
      text?: ResolvableString;
      /** HTML content to add before the input (takes precedence over text) */
      html?: ResolvableString;
    };
    /**
     * Content to add after the input element.
     * Note: The show/hide toggle button is always rendered after the input.
     * Any afterInput content will be rendered after the toggle button.
     */
    afterInput?: {
      /** Text content to add after the input */
      text?: ResolvableString;
      /** HTML content to add after the input (takes precedence over text) */
      html?: ResolvableString;
    };
  };
  /**
   * Additional CSS classes to add to the input element.
   * @example 'govuk-input--width-20' // Fixed width input
   */
  classes?: ResolvableString;
  /**
   * Additional HTML attributes (such as data attributes) to add to the input element.
   * @example { 'data-custom': 'value' }
   */
  attributes?: Record<string, any>;
  /**
   * Button text when the password is hidden.
   * Defaults to 'Show'.
   *
   * @example 'Show password'
   */
  showPasswordText?: ResolvableString;
  /**
   * Button text when the password is visible.
   * Defaults to 'Hide'.
   *
   * @example 'Hide password'
   */
  hidePasswordText?: ResolvableString;
  /**
   * Button text exposed to assistive technologies, like screen readers,
   * when the password is hidden.
   * Defaults to 'Show password'.
   *
   * @example 'Show your password'
   */
  showPasswordAriaLabelText?: ResolvableString;
  /**
   * Button text exposed to assistive technologies, like screen readers,
   * when the password is visible.
   * Defaults to 'Hide password'.
   *
   * @example 'Hide your password'
   */
  hidePasswordAriaLabelText?: ResolvableString;
  /**
   * Announcement made to screen reader users when their password
   * has become visible in plain text.
   * Defaults to 'Your password is visible'.
   *
   * @example 'Password shown'
   */
  passwordShownAnnouncementText?: ResolvableString;
  /**
   * Announcement made to screen reader users when their password
   * has been obscured and is not visible.
   * Defaults to 'Your password is hidden'.
   *
   * @example 'Password hidden'
   */
  passwordHiddenAnnouncementText?: ResolvableString;
  /**
   * Optional object allowing customisation of the toggle button.
   */
  button?: {
    /** Additional CSS classes for the toggle button */
    classes?: ResolvableString;
  };
}
/**
 * GOV.UK Password Input component.
 * A password input component with a show/hide toggle following the GOV.UK Design System patterns.
 *
 * The password input component allows users to enter a password with a toggle button
 * to show or hide the password text. This helps users check they have typed their
 * password correctly, particularly on mobile devices.
 *
 * @see https://design-system.service.gov.uk/components/password-input/
 * @example
 * ```typescript
 * GovUKPasswordInput({
 *   code: 'password',
 *   label: 'Password',
 *   hint: 'Your password must be at least 8 characters',
 *   autocomplete: 'current-password',
 * })
 * ```
 * @example
 * ```typescript
 * // For new password creation (e.g., registration)
 * GovUKPasswordInput({
 *   code: 'new-password',
 *   label: { text: 'Create a password', isPageHeading: true },
 *   hint: 'Your password must contain at least 8 characters, a number, and a special character',
 *   autocomplete: 'new-password',
 * })
 * ```
 */
declare const GovUKPasswordInput: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKPasswordInput, string>;
//#endregion
//#region forge-govuk-components/src/components/textarea-input/govukTextareaInput.d.ts
/**
 * GOV.UK Textarea component.
 * A multi-line text input field.
 *
 * @see https://design-system.service.gov.uk/components/textarea/
 * @example
 * ```typescript
 * GovUKTextareaInput({
 *   code: 'comments',
 *   label: 'Please provide any additional comments',
 *   hint: 'Include as much detail as possible',
 *   rows: '8',
 * })
 * ```
 */
interface GovUKTextareaInput extends FieldBlockDefinition {
  /**
   * The ID of the textarea. Defaults to the value of `code` if not provided.
   *
   * @example 'user-feedback'
   */
  id?: ResolvableString;
  /**
   * Optional field to enable or disable the `spellcheck` attribute on the textarea.
   * When not specified, browsers will use their default behavior.
   *
   * @example true // Enable spellcheck
   */
  spellcheck?: ResolvableBoolean;
  /**
   * Optional number of textarea rows. Defaults to 5 rows if not specified.
   * Controls the initial height of the textarea.
   *
   * @example 8 // Taller textarea
   * @example 3 // Shorter textarea
   */
  rows?: ResolvableNumber | ResolvableString;
  /**
   * The label used by the textarea component.
   * Can be a simple string or a complex object with additional properties.
   *
   * @example 'Your comments' // Simple string label
   * @example { text: 'Feedback', classes: 'govuk-label--l' } // Object with styling
   */
  label?: ResolvableString | {
    /** Text content of the label */
    text?: ResolvableString;
    /** HTML content of the label (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the label */
    classes?: ResolvableString;
    /** Whether to render the label as a page heading (wrapped in h1) */
    isPageHeading?: ResolvableBoolean;
    /** Additional HTML attributes for the label */
    attributes?: Record<string, any>;
  };
  /**
   * Can be used to add a hint to the textarea component.
   * Provides additional context or instructions for the user.
   *
   * @example 'Include as much detail as possible' // Simple string hint
   * @example { html: 'See <a href="/help">guidance</a> for examples' } // Rich HTML hint
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /** Additional options for the form group containing the textarea component. */
  formGroup?: {
    /** Classes to add to the form group wrapper. */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /** Content to add before the textarea input */
    beforeInput?: {
      /** Text content to add before the textarea */
      text?: ResolvableString;
      /** HTML content to add before the textarea (takes precedence over text) */
      html?: ResolvableString;
    };
    /** Content to add after the textarea input. */
    afterInput?: {
      /** Text content to add after the textarea */
      text?: ResolvableString;
      /** HTML content to add after the textarea (takes precedence over text) */
      html?: ResolvableString;
    };
  };
  /** Additional CSS classes to add to the textarea element */
  classes?: ResolvableString;
  /**
   * If `true`, textarea will be disabled and cannot be edited by the user.
   *
   * @example true // Disable the textarea
   */
  disabled?: ResolvableBoolean;
  /**
   * Attribute to meet WCAG success criterion 1.3.5: Identify input purpose.
   * Helps browsers provide appropriate autofill suggestions.
   *
   * @see https://www.w3.org/WAI/WCAG22/Understanding/identify-input-purpose.html
   * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill
   * @example 'street-address' // For address fields
   * @example 'off' // Disable autocomplete
   */
  autocomplete?: ResolvableString;
  /**
   * One or more element IDs to add to the `aria-describedby` attribute.
   * Used to provide additional descriptive information for screenreader users.
   *
   * @example 'comments-guidance'
   */
  describedBy?: ResolvableString;
  /** Additional HTML attributes (such as data attributes) to add to the textarea element. */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Textarea component.
 * A multi-line text input field.
 *
 * @see https://design-system.service.gov.uk/components/textarea/
 * @example
 * ```typescript
 * GovUKTextareaInput({
 *   code: 'comments',
 *   label: 'Please provide any additional comments',
 *   hint: 'Include as much detail as possible',
 *   rows: '8',
 * })
 * ```
 */
declare const GovUKTextareaInput: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKTextareaInput, string>;
//#endregion
//#region forge-govuk-components/src/components/character-count/govukCharacterCount.d.ts
/**
 * GOV.UK Character Count component.
 * Extends textarea with live feedback about remaining characters or words.
 *
 * @see https://design-system.service.gov.uk/components/character-count/
 * @example
 * ```typescript
 * GovUKCharacterCount({
 *   code: 'feedback',
 *   label: 'Provide your feedback',
 *   hint: 'Include as much detail as possible',
 *   maxLength: 500,
 * })
 * ```
 */
interface GovUKCharacterCount extends FieldBlockDefinition {
  /**
   * The ID of the textarea. Defaults to the value of `code` if not provided.
   * @example 'feedback-textarea'
   */
  id?: ResolvableString;
  /**
   * Optional number of textarea rows. Defaults to 5 rows if not specified.
   * Controls the initial height of the textarea.
   * @example 8 // Taller textarea
   * @example 3 // Shorter textarea
   */
  rows?: ResolvableNumber | ResolvableString;
  /**
   * The maximum number of characters allowed.
   * If `maxWords` is provided, this option will be ignored.
   * Either `maxLength` or `maxWords` must be specified.
   * @example 200 // Allow up to 200 characters
   * @example 1000 // Allow up to 1000 characters
   */
  maxLength?: ResolvableNumber;
  /**
   * The maximum number of words allowed.
   * If provided, this takes precedence over `maxLength`.
   * Either `maxLength` or `maxWords` must be specified.
   * @example 150 // Allow up to 150 words
   * @example 500 // Allow up to 500 words
   */
  maxWords?: ResolvableNumber;
  /**
   * The percentage value of the limit at which the count message is displayed.
   * If set, the count message will be hidden until this threshold is reached.
   * @example '75' // Show count when 75% of limit is reached
   * @example '90' // Show count when 90% of limit is reached
   */
  threshold?: ResolvableString;
  /**
   * The label used by the character count component.
   * Can be a simple string or a complex object with additional properties.
   * @example 'Describe the issue' // Simple string label
   * @example { text: 'Feedback', classes: 'govuk-label--l' } // Object with styling
   */
  label: ResolvableString | {
    /** Text content of the label */
    text?: ResolvableString;
    /** HTML content of the label (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the label */
    classes?: ResolvableString;
    /** Whether to render the label as a page heading (wrapped in h1) */
    isPageHeading?: ResolvableBoolean;
    /** Additional HTML attributes for the label */
    attributes?: Record<string, any>;
  };
  /**
   * Can be used to add a hint to the character count component.
   * Provides additional context or instructions for the user.
   * @example 'Include as much detail as possible' // Simple string hint
   * @example { html: 'See <a href="/help">guidance</a> for examples' } // Rich HTML hint
   */
  hint?: ResolvableString | {
    /** Unique ID for the hint (auto-generated if not provided) */
    id?: ResolvableString;
    /** Text content of the hint */
    text?: ResolvableString;
    /** HTML content of the hint (takes precedence over text) */
    html?: ResolvableString;
    /** Additional CSS classes for the hint */
    classes?: ResolvableString;
    /** Additional HTML attributes for the hint */
    attributes?: Record<string, any>;
  };
  /** Additional options for the form group containing the character count component. */
  formGroup?: {
    /** Classes to add to the form group wrapper. */
    classes?: ResolvableString;
    /** HTML attributes to add to the form group wrapper */
    attributes?: Record<string, any>;
    /** Content to add before the textarea input */
    beforeInput?: {
      /** Text content to add before the textarea */
      text?: ResolvableString;
      /** HTML content to add before the textarea (takes precedence over text) */
      html?: ResolvableString;
    };
    /** Content to add after the textarea input (in addition to count message). */
    afterInput?: {
      /** Text content to add after the textarea */
      text?: ResolvableString;
      /** HTML content to add after the textarea (takes precedence over text) */
      html?: ResolvableString;
    };
  };
  /** Additional CSS classes to add to the textarea element */
  classes?: ResolvableString;
  /** Additional HTML attributes (such as data attributes) to add to the textarea element. */
  attributes?: Record<string, any>;
  /**
   * Optional field to enable or disable the `spellcheck` attribute on the textarea.
   * When not specified, browsers will use their default behavior.
   * @example true // Enable spellcheck
   * @example false // Disable spellcheck
   */
  spellcheck?: ResolvableBoolean;
  /** Additional options for the count message displayed below the textarea. */
  countMessage?: {
    /** Additional CSS classes for the count message */
    classes?: ResolvableString;
  };
  /**
   * Message made available to assistive technologies to describe that the component
   * accepts only a limited amount of content. Visible when JavaScript is unavailable.
   * The component will replace the `%{count}` placeholder with the maxLength or maxWords value.
   * @example 'You can enter up to %{count} characters'
   * @example 'Please limit your response to %{count} words'
   */
  textareaDescriptionText?: ResolvableString;
  /**
   * Message displayed when the number of characters is under the configured maximum.
   * The component will replace the `%{count}` placeholder with the number of remaining characters.
   * Supports pluralization rules for different languages.
   * @example { one: 'You have %{count} character remaining', other: 'You have %{count} characters remaining' }
   */
  charactersUnderLimitText?: {
    /** Message when exactly 1 character remains */
    one?: ResolvableString;
    /** Message when multiple characters remain */
    other?: ResolvableString;
  };
  /**
   * Message displayed when the number of characters reaches the configured maximum.
   * This message is displayed visually and through assistive technologies.
   * @example 'You have reached the character limit'
   */
  charactersAtLimitText?: ResolvableString;
  /**
   * Message displayed when the number of characters exceeds the configured maximum.
   * The component will replace the `%{count}` placeholder with the number of characters over the limit.
   * Supports pluralization rules for different languages.
   * @example { one: 'You are %{count} character over the limit', other: 'You are %{count} characters over the limit' }
   */
  charactersOverLimitText?: {
    /** Message when exactly 1 character over limit */
    one?: ResolvableString;
    /** Message when multiple characters over limit */
    other?: ResolvableString;
  };
  /**
   * Message displayed when the number of words is under the configured maximum.
   * The component will replace the `%{count}` placeholder with the number of remaining words.
   * Supports pluralization rules for different languages.
   * @example { one: 'You have %{count} word remaining', other: 'You have %{count} words remaining' }
   */
  wordsUnderLimitText?: {
    /** Message when exactly 1 word remains */
    one?: ResolvableString;
    /** Message when multiple words remain */
    other?: ResolvableString;
  };
  /**
   * Message displayed when the number of words reaches the configured maximum.
   * This message is displayed visually and through assistive technologies.
   * @example 'You have reached the word limit'
   */
  wordsAtLimitText?: ResolvableString;
  /**
   * Message displayed when the number of words exceeds the configured maximum.
   * The component will replace the `%{count}` placeholder with the number of words over the limit.
   * Supports pluralization rules for different languages.
   * @example { one: 'You are %{count} word over the limit', other: 'You are %{count} words over the limit' }
   */
  wordsOverLimitText?: {
    /** Message when exactly 1 word over limit */
    one?: ResolvableString;
    /** Message when multiple words over limit */
    other?: ResolvableString;
  };
}
/**
 * GOV.UK Character Count component.
 * Extends textarea with live feedback about remaining characters or words.
 *
 * @see https://design-system.service.gov.uk/components/character-count/
 * @example
 * ```typescript
 * GovUKCharacterCount({
 *   code: 'feedback',
 *   label: 'Provide your feedback',
 *   hint: 'Include as much detail as possible',
 *   maxLength: 500,
 * })
 * ```
 */
declare const GovUKCharacterCount: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKCharacterCount, string>;
//#endregion
//#region forge-govuk-components/src/components/details/govukDetails.d.ts
/**
 * GOV.UK Details component.
 *
 * An expandable/collapsible section following the GOV.UK Design System patterns.
 * Renders as a `<details>` element with summary and content sections.
 *
 * @see https://design-system.service.gov.uk/components/details/
 * @example
 * ```typescript
 * GovUKDetails({
 *   summaryText: 'Help with nationality',
 *   text: 'We need to know your nationality so we can work out which elections you can vote in.',
 * })
 * ```
 */
interface GovUKDetails extends BlockDefinition {
  /** Text to display in the summary (clickable part). Required unless summaryHtml is provided. */
  summaryText?: ResolvableString;
  /** HTML to display in the summary (clickable part). Takes precedence over summaryText. */
  summaryHtml?: ResolvableString;
  /** Plain text content for the expandable section */
  text?: ResolvableString;
  /** HTML content for the expandable section. Takes precedence over text. */
  html?: ResolvableString;
  /** Child blocks to render in the expandable section. Takes precedence over text/html. */
  content?: BlockDefinition[];
  /** Whether the details should be expanded by default */
  open?: ResolvableBoolean;
  /** ID attribute for the details element */
  id?: ResolvableString;
  /** Additional CSS classes for the details element */
  classes?: ResolvableString;
  /** Custom HTML attributes for the details element */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Details component.
 *
 * An expandable/collapsible section following the GOV.UK Design System patterns.
 * Renders as a `<details>` element with summary and content sections.
 *
 * @see https://design-system.service.gov.uk/components/details/
 * @example
 * ```typescript
 * GovUKDetails({
 *   summaryText: 'Help with nationality',
 *   text: 'We need to know your nationality so we can work out which elections you can vote in.',
 * })
 * ```
 */
declare const GovUKDetails: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKDetails, string>;
//#endregion
//#region forge-govuk-components/src/components/exit-this-page/govukExitThisPage.d.ts
/**
 * GOV.UK Exit This Page component.
 *
 * A safety feature providing a quick escape route. Use it on pages with sensitive
 * information where users may need to hide what they're viewing quickly.
 *
 * Users can activate the exit by clicking the button or pressing Shift 3 times.
 *
 * @see https://design-system.service.gov.uk/components/exit-this-page/
 * @example
 * ```typescript
 * // Basic usage with default redirect
 * GovUKExitThisPage({})
 *
 * // With custom redirect URL
 * GovUKExitThisPage({
 *   redirectUrl: 'https://www.google.co.uk',
 * })
 *
 * // With custom button text
 * GovUKExitThisPage({
 *   text: 'Leave this page',
 *   redirectUrl: 'https://www.google.co.uk',
 * })
 * ```
 */
interface GovUKExitThisPage extends BlockDefinition {
  /**
   * Plain text content for the button.
   * If `html` is provided, this option will be ignored.
   * Defaults to "Emergency Exit this page" with 'Emergency' visually hidden.
   */
  text?: ResolvableString;
  /**
   * HTML content for the button.
   * Takes precedence over `text` if both are provided.
   * Defaults to "Emergency Exit this page" with 'Emergency' visually hidden.
   */
  html?: ResolvableString;
  /**
   * URL to redirect the current tab to when the exit button is activated.
   * Defaults to "https://www.bbc.co.uk/weather".
   */
  redirectUrl?: ResolvableString;
  /**
   * ID attribute to add to the exit this page container.
   */
  id?: ResolvableString;
  /**
   * Additional CSS classes to add to the exit this page container.
   */
  classes?: ResolvableString;
  /**
   * HTML attributes (for example data attributes) to add to the exit this page container.
   */
  attributes?: Record<string, any>;
  /**
   * Text announced by screen readers when Exit this Page has been activated
   * via the keyboard shortcut.
   * Defaults to "Loading.".
   */
  activatedText?: ResolvableString;
  /**
   * Text announced by screen readers when the keyboard shortcut has timed out
   * without successful activation.
   * Defaults to "Exit this page expired.".
   */
  timedOutText?: ResolvableString;
  /**
   * Text announced by screen readers when the user must press Shift two more
   * times to activate the button.
   * Defaults to "Shift, press 2 more times to exit.".
   */
  pressTwoMoreTimesText?: ResolvableString;
  /**
   * Text announced by screen readers when the user must press Shift one more
   * time to activate the button.
   * Defaults to "Shift, press 1 more time to exit.".
   */
  pressOneMoreTimeText?: ResolvableString;
}
/**
 * GOV.UK Exit This Page component.
 *
 * A safety feature providing a quick escape route. Use it on pages with sensitive
 * information where users may need to hide what they're viewing quickly.
 *
 * Users can activate the exit by clicking the button or pressing Shift 3 times.
 *
 * @see https://design-system.service.gov.uk/components/exit-this-page/
 * @example
 * ```typescript
 * // Basic usage with default redirect
 * GovUKExitThisPage({})
 *
 * // With custom redirect URL
 * GovUKExitThisPage({
 *   redirectUrl: 'https://www.google.co.uk',
 * })
 *
 * // With custom button text
 * GovUKExitThisPage({
 *   text: 'Leave this page',
 *   redirectUrl: 'https://www.google.co.uk',
 * })
 * ```
 */
declare const GovUKExitThisPage: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKExitThisPage, string>;
//#endregion
//#region forge-govuk-components/src/components/inset-text/govukInsetText.d.ts
/**
 * GOV.UK Inset Text component.
 *
 * Use this to differentiate a block of text from the surrounding content.
 * Useful for quotes, examples, or additional information that needs visual distinction.
 *
 * @see https://design-system.service.gov.uk/components/inset-text/
 * @example
 * ```typescript
 * GovUKInsetText({
 *   text: 'It can take up to 8 weeks to register a lasting power of attorney if there are no mistakes in the application.',
 * })
 * ```
 */
interface GovUKInsetText extends BlockDefinition {
  /**
   * Plain text content for the inset text.
   * Required unless `html` is provided.
   * If `html` is provided, this option will be ignored.
   */
  text?: ResolvableString;
  /**
   * HTML content for the inset text.
   * Takes precedence over `text` if both are provided.
   * Use this when you need to include links or other HTML elements.
   */
  html?: ResolvableString;
  /**
   * Child blocks to render in the inset text.
   * Takes precedence over `text` and `html`.
   */
  blocks?: BlockDefinition[];
  /**
   * ID attribute to add to the inset text container.
   * Useful for linking to this specific section or for testing.
   */
  id?: ResolvableString;
  /**
   * Additional CSS classes to add to the inset text container.
   * Use this to apply custom styling or spacing classes.
   */
  classes?: ResolvableString;
  /**
   * HTML attributes (for example data attributes) to add to the inset text container.
   * Useful for adding custom data attributes or ARIA attributes.
   */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Inset Text component.
 *
 * Use this to differentiate a block of text from the surrounding content.
 * Useful for quotes, examples, or additional information that needs visual distinction.
 *
 * @see https://design-system.service.gov.uk/components/inset-text/
 * @example
 * ```typescript
 * GovUKInsetText({
 *   text: 'It can take up to 8 weeks to register a lasting power of attorney if there are no mistakes in the application.',
 * })
 * ```
 */
declare const GovUKInsetText: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKInsetText, string>;
//#endregion
//#region forge-govuk-components/src/components/notification-banner/govukNotificationBanner.d.ts
/**
 * GOV.UK Notification Banner component.
 *
 * Use this to display important notifications to users, such as success messages
 * or important information they need to know about.
 *
 * @see https://design-system.service.gov.uk/components/notification-banner/
 * @example
 * ```typescript
 * // Basic important notification
 * GovUKNotificationBanner({
 *   text: 'You have 7 days left to send your application.',
 * })
 *
 * // Success notification
 * GovUKNotificationBanner({
 *   bannerType: 'success',
 *   text: 'Training outcome recorded and trainee withdrawn',
 * })
 *
 * // With custom title
 * GovUKNotificationBanner({
 *   titleText: 'Application received',
 *   text: 'We will review your application and get back to you within 5 working days.',
 * })
 * ```
 */
interface GovUKNotificationBanner extends BlockDefinition {
  /**
   * The text that displays in the notification banner.
   * You can use any string with this option.
   * If you set `html`, this option is not required and is ignored.
   */
  text?: ResolvableString;
  /**
   * The HTML to use within the notification banner.
   * You can use any string with this option.
   * If you set `html`, `text` is not required and is ignored.
   */
  html?: ResolvableString;
  /**
   * Child blocks to render in the notification banner content area.
   * Takes precedence over text/html.
   */
  content?: BlockDefinition[];
  /**
   * The title text that displays in the notification banner.
   * You can use any string with this option.
   * Use this option to set text that does not contain HTML.
   *
   * The available default values are 'Important', 'Success', and null:
   * - if you do not set `bannerType`, `titleText` defaults to "Important"
   * - if you set `bannerType` to "success", `titleText` defaults to "Success"
   * - if you set `titleHtml`, this option is ignored
   */
  titleText?: ResolvableString;
  /**
   * The title HTML to use within the notification banner.
   * You can use any string with this option.
   * Use this option to set text that contains HTML.
   * If you set `titleHtml`, the `titleText` option is ignored.
   */
  titleHtml?: ResolvableString;
  /**
   * Sets heading level for the title only.
   * You can only use values between 1 and 6 with this option.
   * The default is 2.
   */
  titleHeadingLevel?: ResolvableString;
  /**
   * The type of notification to render.
   * You can use only "success" or null values with this option.
   *
   * If you set `bannerType` to "success", the notification banner sets `role` to "alert".
   * JavaScript then moves the keyboard focus to the notification banner when the page loads.
   *
   * If you do not set `bannerType`, the notification banner sets `role` to "region".
   *
   * Note: This property is named `bannerType` instead of `type` to avoid conflict
   * with the forge block definition type discriminator.
   */
  bannerType?: ResolvableString;
  /**
   * Overrides the value of the `role` attribute for the notification banner.
   * Defaults to "region".
   * If you set `bannerType` to "success", `role` defaults to "alert".
   */
  role?: ResolvableString;
  /**
   * The `id` for the banner title, and the `aria-labelledby` attribute in the banner.
   * Defaults to "govuk-notification-banner-title".
   */
  titleId?: ResolvableString;
  /**
   * If you set `bannerType` to "success", or `role` to "alert", JavaScript moves
   * the keyboard focus to the notification banner when the page loads.
   * To disable this behaviour, set `disableAutoFocus` to true.
   */
  disableAutoFocus?: ResolvableBoolean;
  /** Additional CSS classes for the notification banner container */
  classes?: ResolvableString;
  /** Custom HTML attributes for the notification banner container */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Notification Banner component.
 *
 * Use this to display important notifications to users, such as success messages
 * or important information they need to know about.
 *
 * @see https://design-system.service.gov.uk/components/notification-banner/
 * @example
 * ```typescript
 * // Basic important notification
 * GovUKNotificationBanner({
 *   text: 'You have 7 days left to send your application.',
 * })
 *
 * // Success notification
 * GovUKNotificationBanner({
 *   bannerType: 'success',
 *   text: 'Training outcome recorded and trainee withdrawn',
 * })
 *
 * // With custom title
 * GovUKNotificationBanner({
 *   titleText: 'Application received',
 *   text: 'We will review your application and get back to you within 5 working days.',
 * })
 * ```
 */
declare const GovUKNotificationBanner: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKNotificationBanner, string>;
//#endregion
//#region forge-govuk-components/src/components/panel/govukPanel.d.ts
/**
 * GOV.UK Panel component.
 *
 * Use this to display a confirmation panel, typically shown on confirmation pages
 * at the end of a transaction. Renders with a turquoise background and white text.
 *
 * @see https://design-system.service.gov.uk/components/panel/
 * @example
 * ```typescript
 * GovUKPanel({
 *   titleText: 'Application complete',
 *   text: 'Your reference number is HDJ2123F',
 * })
 * ```
 */
interface GovUKPanel extends BlockDefinition {
  /**
   * Plain text to use within the panel title.
   * Required unless `titleHtml` is provided.
   * If `titleHtml` is provided, this option will be ignored.
   */
  titleText?: ResolvableString;
  /**
   * HTML to use within the panel title.
   * Takes precedence over `titleText`.
   * If `titleHtml` is provided, the `titleText` option will be ignored.
   */
  titleHtml?: ResolvableString;
  /**
   * Heading level for the panel title, from 1 to 6.
   * Defaults to 1 (h1).
   */
  headingLevel?: ResolvableNumber;
  /**
   * Plain text content for the panel body.
   * Required unless `html` is provided.
   * If `html` is provided, this option will be ignored.
   */
  text?: ResolvableString;
  /**
   * HTML content for the panel body.
   * Takes precedence over `text`.
   * If `html` is provided, the `text` option will be ignored.
   */
  html?: ResolvableString;
  /**
   * Child blocks to render in the panel body.
   * Takes precedence over `text` and `html`.
   */
  blocks?: BlockDefinition[];
  /**
   * Additional CSS classes for the panel container.
   */
  classes?: ResolvableString;
  /**
   * Custom HTML attributes (for example data attributes) to add to the panel container.
   */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Panel component.
 *
 * Use this to display a confirmation panel, typically shown on confirmation pages
 * at the end of a transaction. Renders with a turquoise background and white text.
 *
 * @see https://design-system.service.gov.uk/components/panel/
 * @example
 * ```typescript
 * GovUKPanel({
 *   titleText: 'Application complete',
 *   text: 'Your reference number is HDJ2123F',
 * })
 * ```
 */
declare const GovUKPanel: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKPanel, string>;
//#endregion
//#region forge-govuk-components/src/components/tag/govukTag.d.ts
/**
 * GOV.UK Tag component.
 *
 * Use this to display a status indicator, phase banner label, or other short
 * piece of information that needs to stand out from surrounding content. Tags are
 * compact, coloured labels used to show the status of something, like a phase
 * banner or task status.
 *
 * Different colours can be applied using the `classes` property with modifier
 * classes like `govuk-tag--grey`, `govuk-tag--green`, `govuk-tag--teal`,
 * `govuk-tag--blue`, `govuk-tag--purple`, `govuk-tag--magenta`,
 * `govuk-tag--red`, `govuk-tag--orange`, or `govuk-tag--yellow`.
 *
 * @see https://design-system.service.gov.uk/components/tag/
 * @example
 * ```typescript
 * // Default blue tag
 * GovUKTag({
 *   text: 'Active',
 * })
 *
 * // Green tag for completed status
 * GovUKTag({
 *   text: 'Completed',
 *   classes: 'govuk-tag--green',
 * })
 *
 * // Red tag for error status
 * GovUKTag({
 *   text: 'Failed',
 *   classes: 'govuk-tag--red',
 * })
 * ```
 */
interface GovUKTag extends BlockDefinition {
  /**
   * Plain text content for the tag.
   * Required unless `html` is provided.
   * If `html` is provided, this option will be ignored.
   */
  text?: ResolvableString;
  /**
   * HTML content for the tag.
   * Takes precedence over `text` if both are provided.
   * Use this when you need to include HTML elements within the tag.
   */
  html?: ResolvableString;
  /**
   * Additional CSS classes to add to the tag.
   * Use modifier classes to change the tag colour:
   * - `govuk-tag--grey` - Grey tag for inactive or default states
   * - `govuk-tag--green` - Green tag for success or completed states
   * - `govuk-tag--teal` - Teal tag
   * - `govuk-tag--blue` - Blue tag (default colour if no modifier)
   * - `govuk-tag--purple` - Purple tag
   * - `govuk-tag--magenta` - Magenta tag
   * - `govuk-tag--red` - Red tag for errors or urgent states
   * - `govuk-tag--orange` - Orange tag for warnings
   * - `govuk-tag--yellow` - Yellow tag for pending or attention states
   */
  classes?: ResolvableString;
  /**
   * HTML attributes (for example data attributes) to add to the tag.
   * Useful for adding custom data attributes or ARIA attributes.
   */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Tag component.
 *
 * Use this to display a status indicator, phase banner label, or other short
 * piece of information that needs to stand out from surrounding content. Tags are
 * compact, coloured labels used to show the status of something, like a phase
 * banner or task status.
 *
 * Different colours can be applied using the `classes` property with modifier
 * classes like `govuk-tag--grey`, `govuk-tag--green`, `govuk-tag--teal`,
 * `govuk-tag--blue`, `govuk-tag--purple`, `govuk-tag--magenta`,
 * `govuk-tag--red`, `govuk-tag--orange`, or `govuk-tag--yellow`.
 *
 * @see https://design-system.service.gov.uk/components/tag/
 * @example
 * ```typescript
 * // Default blue tag
 * GovUKTag({
 *   text: 'Active',
 * })
 *
 * // Green tag for completed status
 * GovUKTag({
 *   text: 'Completed',
 *   classes: 'govuk-tag--green',
 * })
 *
 * // Red tag for error status
 * GovUKTag({
 *   text: 'Failed',
 *   classes: 'govuk-tag--red',
 * })
 * ```
 */
declare const GovUKTag: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKTag, string>;
//#endregion
//#region forge-govuk-components/src/components/warning-text/govukWarningText.d.ts
/**
 * GOV.UK Warning Text component.
 *
 * Use this to display important warnings to users. Renders with an exclamation mark
 * icon and bold text styling following the GOV.UK Design System.
 *
 * @see https://design-system.service.gov.uk/components/warning-text/
 * @example
 * ```typescript
 * GovUKWarningText({
 *   text: 'You can be fined up to £5,000 if you do not register.',
 * })
 * ```
 */
interface GovUKWarningText extends BlockDefinition {
  /** Plain text content for the warning. Required unless html is provided. */
  text?: ResolvableString;
  /** HTML content for the warning. Takes precedence over text. */
  html?: ResolvableString;
  /** Child blocks to render in the warning. Takes precedence over text/html. */
  blocks?: BlockDefinition[];
  /** Fallback text for the warning icon (for screen readers). Defaults to "Warning". */
  iconFallbackText?: ResolvableString;
  /** Additional CSS classes for the warning text container */
  classes?: ResolvableString;
  /** Custom HTML attributes for the warning text container */
  attributes?: Record<string, any>;
}
/**
 * GOV.UK Warning Text component.
 *
 * Use this to display important warnings to users. Renders with an exclamation mark
 * icon and bold text styling following the GOV.UK Design System.
 *
 * @see https://design-system.service.gov.uk/components/warning-text/
 * @example
 * ```typescript
 * GovUKWarningText({
 *   text: 'You can be fined up to £5,000 if you do not register.',
 * })
 * ```
 */
declare const GovUKWarningText: import("@ministryofjustice/hmpps-forge/core/components").ForgeComponent<GovUKWarningText, string>;
//#endregion
//#region forge-govuk-components/src/components/index.d.ts
/** All GOV.UK component definitions */
declare const govukComponents: ComponentRegistryEntry<BlockDefinition, string>[];
//#endregion
//#region forge-govuk-components/src/utils/govukUtilityClasses.d.ts
/**
 * GOV.UK Design System utility CSS classes.
 *
 * These classes can be used to modify component appearance without
 * writing custom CSS. Use them in field definitions via the `classes` property.
 *
 * @see https://design-system.service.gov.uk/
 */
declare const GovUKUtilityClasses: {
  /** Hide content visually while keeping it accessible to screen readers */
  VisuallyHidden: string;
  /** Hide content visually but make it visible when focused (e.g. skip links) */
  VisuallyHiddenFocusable: string;
  /**
   * Fixed-width input classes. The width roughly corresponds to the number
   * of characters that will fit in the input at the standard font size.
   *
   * @see https://design-system.service.gov.uk/components/text-input/#use-appropriately-sized-text-inputs
   */
  Input: {
    /** 2 character width (e.g. day, age) */
    Width2: string;
    /** 3 character width (e.g. area code) */
    Width3: string;
    /** 4 character width (e.g. year, PIN) */
    Width4: string;
    /** 5 character width (e.g. postcode) */
    Width5: string;
    /** 10 character width (e.g. phone number) */
    Width10: string;
    /** 20 character width (e.g. name, email) */
    Width20: string;
    /** 30 character width (e.g. address line) */
    Width30: string;
    /** Tabular numbers with extra letter spacing (e.g. reference numbers) */
    ExtraLetterSpacing: string;
  };
  /** Label size modifiers */
  Label: {
    /** Extra large label (48px, typically for single-field page headings) */
    ExtraLarge: string;
    /** Large label (36px) */
    Large: string;
    /** Medium label (24px) */
    Medium: string;
    /** Small label (bold, standard size) */
    Small: string;
  };
  /** Fieldset legend size modifiers */
  Fieldset: {
    /** Extra large legend text (48px, typically for page headings) */
    ExtraLargeLabel: string;
    /** Large legend text (36px) */
    LargeLabel: string;
    /** Medium legend text (24px) */
    MediumLabel: string;
    /** Small legend text (bold, standard size) */
    SmallLabel: string;
  };
  /** Radio button layout modifiers */
  Radios: {
    /** Display radio buttons horizontally instead of stacked */
    Inline: string;
    /** Use smaller radio button styling (24px instead of 40px) */
    Small: string;
  };
  /** Checkbox layout modifiers */
  Checkboxes: {
    /** Use smaller checkbox styling (24px instead of 40px) */
    Small: string;
  };
  /**
   * Tag colour variants.
   *
   * @see https://design-system.service.gov.uk/components/tag/
   */
  Tag: {
    Blue: string;
    Green: string;
    Grey: string;
    Red: string;
    Orange: string;
    Yellow: string;
    Purple: string;
    Teal: string;
    Magenta: string;
  };
  /**
   * Responsive width override classes. Full width on mobile,
   * specified fraction on tablet and above.
   *
   * @see https://design-system.service.gov.uk/styles/layout/#width-override-classes
   */
  Width: {
    Full: string;
    ThreeQuarters: string;
    TwoThirds: string;
    OneHalf: string;
    OneThird: string;
    OneQuarter: string;
  };
  /** Display override classes */
  Display: {
    Inline: string;
    InlineBlock: string;
    Block: string;
    None: string;
    /** Hidden in print only */
    NonePrint: string;
  };
  /**
   * Responsive font size overrides.
   *
   * @see https://design-system.service.gov.uk/styles/typography/#font-size
   */
  FontSize: {
    Size16: string;
    Size19: string;
    Size24: string;
    Size27: string;
    Size36: string;
    Size48: string;
    Size80: string;
  };
  /** Font weight overrides */
  FontWeight: {
    Regular: string;
    Bold: string;
  };
  /** Text alignment overrides */
  TextAlign: {
    Left: string;
    Centre: string;
    Right: string;
  };
  /**
   * Responsive margin overrides (scale 0–9).
   *
   * Spacing scale: 0=0, 1=5px, 2=10px, 3=15px, 4=20px, 5=25px, 6=30px, 7=40px, 8=50px, 9=60px
   * (values 4–9 are smaller on mobile).
   *
   * @see https://design-system.service.gov.uk/styles/spacing/#spacing-override-classes
   */
  Margin: {
    All0: string;
    All1: string;
    All2: string;
    All3: string;
    All4: string;
    All5: string;
    All6: string;
    All7: string;
    All8: string;
    All9: string;
    Top0: string;
    Top1: string;
    Top2: string;
    Top3: string;
    Top4: string;
    Top5: string;
    Top6: string;
    Top7: string;
    Top8: string;
    Top9: string;
    Right0: string;
    Right1: string;
    Right2: string;
    Right3: string;
    Right4: string;
    Right5: string;
    Right6: string;
    Right7: string;
    Right8: string;
    Right9: string;
    Bottom0: string;
    Bottom1: string;
    Bottom2: string;
    Bottom3: string;
    Bottom4: string;
    Bottom5: string;
    Bottom6: string;
    Bottom7: string;
    Bottom8: string;
    Bottom9: string;
    Left0: string;
    Left1: string;
    Left2: string;
    Left3: string;
    Left4: string;
    Left5: string;
    Left6: string;
    Left7: string;
    Left8: string;
    Left9: string;
  };
  /**
   * Responsive padding overrides (scale 0–9).
   *
   * Spacing scale: 0=0, 1=5px, 2=10px, 3=15px, 4=20px, 5=25px, 6=30px, 7=40px, 8=50px, 9=60px
   * (values 4–9 are smaller on mobile).
   *
   * @see https://design-system.service.gov.uk/styles/spacing/#spacing-override-classes
   */
  Padding: {
    All0: string;
    All1: string;
    All2: string;
    All3: string;
    All4: string;
    All5: string;
    All6: string;
    All7: string;
    All8: string;
    All9: string;
    Top0: string;
    Top1: string;
    Top2: string;
    Top3: string;
    Top4: string;
    Top5: string;
    Top6: string;
    Top7: string;
    Top8: string;
    Top9: string;
    Right0: string;
    Right1: string;
    Right2: string;
    Right3: string;
    Right4: string;
    Right5: string;
    Right6: string;
    Right7: string;
    Right8: string;
    Right9: string;
    Bottom0: string;
    Bottom1: string;
    Bottom2: string;
    Bottom3: string;
    Bottom4: string;
    Bottom5: string;
    Bottom6: string;
    Bottom7: string;
    Bottom8: string;
    Bottom9: string;
    Left0: string;
    Left1: string;
    Left2: string;
    Left3: string;
    Left4: string;
    Left5: string;
    Left6: string;
    Left7: string;
    Left8: string;
    Left9: string;
  };
};
//#endregion
//#region forge-govuk-components/src/utils/validations/dateInputFull.d.ts
type ValidationMessage = string | {
  message: string;
  submissionOnly?: boolean;
};
interface DateInputFullMessages {
  empty: ValidationMessage;
  missingDay: ValidationMessage;
  missingMonth: ValidationMessage;
  missingYear: ValidationMessage;
  invalid: ValidationMessage;
  mustBePast?: ValidationMessage;
  mustBeFuture?: ValidationMessage;
}
declare function DateInputFull(messages: DateInputFullMessages): ValidationExpr[];
//#endregion
//#region forge-govuk-components/src/utils/govukValidations.d.ts
declare const GovUKValidations: {
  DateInputFull: typeof DateInputFull;
};
//#endregion
//#region forge-govuk-components/src/utils/registerForgeGovUKComponentsGlobals.d.ts
declare function registerForgeGovUKComponentsGlobals(nunjucksEnv: Environment): void;
//#endregion
export { type AccordionItem, type AccordionItemContent, type AccordionItemHeading, type AccordionItemSummary, type BreadcrumbItem, GovUKAccordion, GovUKBackLink, GovUKBody, GovUKBreadcrumbs, GovUKButton, GovUKButtonGroup, GovUKCharacterCount, GovUKCheckboxInput, type GovUKCheckboxInputDivider, type GovUKCheckboxInputItem, type GovUKDateInputBase, GovUKDateInputFull, GovUKDateInputMonthDay, GovUKDateInputYearMonth, GovUKDetails, GovUKExitThisPage, type GovUKGridColumn, GovUKGridRow, GovUKHeading, GovUKInsetText, GovUKLinkButton, GovUKList, GovUKNotificationBanner, GovUKPagination, GovUKPanel, GovUKPasswordInput, GovUKRadioInput, type GovUKRadioInputDivider, type GovUKRadioInputItem, GovUKSectionBreak, GovUKSelectInput, GovUKSummaryList, GovUKTable, GovUKTabs, GovUKTag, GovUKTaskList, GovUKTextInput, GovUKTextareaInput, GovUKUtilityClasses, GovUKValidations, GovUKWarningText, type PaginationItem, type PaginationLink, type SelectItem, type SummaryCard, type SummaryCardTitle, type SummaryListActionItem, type SummaryListActions, type SummaryListKey, type SummaryListRow, type SummaryListValue, type TabItem, type TabPanel, type TableCell, type TableHeadCell, type TableRow, type TaskListHint, type TaskListItem, type TaskListStatus, type TaskListStatusTag, type TaskListTitle, govukComponents, registerForgeGovUKComponentsGlobals };