Type alias SettingsRef

SettingsRef: {
    register: ((callback: ((settings: Settings) => void)) => void);
    update: ((updater: ((settings: Settings) => void)) => void);
}

Settings API managing settings applied to the component.

Type declaration

  • register: ((callback: ((settings: Settings) => void)) => void)
      • (callback: ((settings: Settings) => void)): void

      • Registers a callback function to be notified when settings are updated.

        Parameters

        • callback: ((settings: Settings) => void)

          A function to be called when settings are updated, receiving the updated settings.

        Returns void

  • update: ((updater: ((settings: Settings) => void)) => void)
      • (updater: ((settings: Settings) => void)): void

      • Allows updating settings by providing a callback function.

        Parameters

        • updater: ((settings: Settings) => void)

          A function that updates the current settings.

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc