Flarum (2.x)
    Preparing search index...
    Index
    • Where a setting is shown on its extension's page: its section and the tab that section is on.

      Settings in the leading group, before any section, are shown on the first tab.

      Parameters

      • extensionId: string
      • setting:
            | HTMLInputFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | SwitchFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | SelectFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | TextareaFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | ColorPreviewFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | IconFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | ImageUploadFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | StackedFormControlFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | CustomFieldComponentOptions & {
                json?: boolean;
                link?: string;
                refreshAfterSaving?: boolean;
                section?: string;
                setting: string;
            }
            | () => Children & { section?: string; setting: string }
            | () => Children & { section?: string }
        • HTMLInputFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • SwitchFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • SelectFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • TextareaFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • ColorPreviewFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • IconFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • ImageUploadFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • StackedFormControlFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • CustomFieldComponentOptions & {
              json?: boolean;
              link?: string;
              refreshAfterSaving?: boolean;
              section?: string;
              setting: string;
          }
          • Optionaljson?: boolean
          • Optionallink?: string

            Optional: The URL to navigate to when this setting appears in admin search. The default is the group link, then the page or extension route.

          • OptionalrefreshAfterSaving?: boolean
          • Optionalsection?: string

            The id of the settings section to show this setting in.

          • setting: string
        • () => Children & { section?: string; setting: string }
        • () => Children & { section?: string }

      Returns SettingLocation

    • Registers a titled group of settings. Settings join it through their section key.

      Parameters

      Returns this

      .registerSection({
      id: 'notifications',
      label: app.translator.trans('acme-foo.admin.settings.notifications_heading'),
      description: app.translator.trans('acme-foo.admin.settings.notifications_text'),
      icon: 'fas fa-bell',
      }, 50)
    • This function registers your settings with Flarum

      It takes either a settings object or a callback.

      Parameters

      Returns this

      .registerSetting({
      setting: 'flarum-flags.guidelines_url',
      type: 'text', // This will be inputted into the input tag for the setting (text/number/etc)
      label: app.translator.trans('flarum-flags.admin.settings.guidelines_url_label')
      }, 15) // priority is optional (ItemList)