File

projects/storefrontlib/layout/direction/config/direction.model.ts

Description

Contains the configuration mode for language driven directionality. The detect mode is recommended for a multi-site or multi-lingual setup where the active language should dictate the direction mode.

Index

Properties

Properties

default
default: DirectionMode
Type : DirectionMode
Optional

The default direction mode is used for the direction mode of the overall storefront. The default mode can be used for all languages, but can be further enhanced dynamically by using the language detect mode. The default mode will also be used in detect mode for those languages that are not listed in either rtlLanguages or ltrLanguages.

detect
detect: boolean
Type : boolean
Optional

If detect is enabled, the direction is driven by the active language. The language is compared to the list of configured rtlLanguages vs ltrLanguages. If no language is resolved, the default direction mode is used.

If no direction can be resolved, the direction is removed.

ltrLanguages
ltrLanguages: string[]
Type : string[]
Optional

The language isoCodes that are used to detect Left to Right languages.

rtlLanguages
rtlLanguages: string[]
Type : string[]
Optional

The language isoCodes that are used to detect Right to Left languages.

export enum DirectionMode {
  /**
   * Indicates Left to Right direction.
   */
  LTR = 'ltr',
  /**
   * Indicates Right to Left direction.
   */
  RTL = 'rtl',
}

/**
 * Contains the configuration mode for language driven directionality. The detect mode is recommended
 * for a multi-site or multi-lingual setup where the active language should dictate the direction mode.
 */
export interface Direction {
  /**
   * The default direction mode is used for the direction mode of the overall storefront. The default mode
   * can be used for all languages, but can be further enhanced dynamically by using the language detect mode.
   * The default mode will also be used in detect mode for those languages that are not listed in either
   * `rtlLanguages` or `ltrLanguages`.
   */
  default?: DirectionMode;

  /**
   * If detect is enabled, the direction is driven by the active language. The language is compared to the
   * list of configured `rtlLanguages` vs `ltrLanguages`. If no language is resolved, the default direction
   * mode is used.
   *
   * If no direction can be resolved, the direction is removed.
   */
  detect?: boolean;

  /**
   * The language isoCodes that are used to detect Right to Left languages.
   */
  rtlLanguages?: string[];

  /**
   * The language isoCodes that are used to detect Left to Right languages.
   */
  ltrLanguages?: string[];
}

result-matching ""

    No results matching ""