class Flipper::UI::Configuration

Constants

DEFAULT_ACTOR_NAMES_SOURCE
DEFAULT_DESCRIPTIONS_SOURCE
VALID_BANNER_CLASS_VALUES

Attributes

actor_names_source[RW]

Public: If you set this, Flipper::UI will fetch actor names from your external source. Descriptions for ‘actors` will be shown on `feature` page. Defaults to empty block.

actors_separator[RW]

Public: What should be used to denote you are trying to add multiple actors at once (instead of just a single actor). Default is comma “,”.

add_actor_placeholder[RW]

Public: What should show up in the form to add actors. This can be different per application since flipper_id’s can be whatever an application needs. Defaults to “a flipper id”.

application_breadcrumb_href[RW]

Public: If you set this, the UI will always have a first nav item that says “App” which points to this href. The href can be a path (ie: “/”) or full url (“app.example.com/”).

application_breadcrumb_href=[RW]

Public: If you set this, the UI will always have a first nav item that says “App” which points to this href. The href can be a path (ie: “/”) or full url (“app.example.com/”).

application_href[RW]

Public: If you set this, the UI will always have a first nav item that says “App” which points to this href. The href can be a path (ie: “/”) or full url (“app.example.com/”).

banner_class[RW]
banner_text[RW]
cloud_recommendation[RW]

Public: Tired of seeing the awesome message about Cloud? Set this to false and it will go away. Defaults to true.

confirm_disable[RW]

Public: if you want to get a confirm pop up box while disabling a feature Default is false.

confirm_fully_enable[RW]

Public: if you want to get a confirm pop up box while fully enabling a feature Default is false.

delete[R]
descriptions_source[RW]

Public: If you set this, Flipper::UI will fetch descriptions from your external source. Descriptions for ‘features` will be shown on `feature` page, and optionally the `features` pages. Defaults to empty block.

feature_creation_enabled[RW]

Public: Is feature creation allowed from the UI? Defaults to true. If set to false, users of the UI cannot create features. All feature creation will need to be done through the configured flipper instance.

feature_removal_enabled[RW]

Public: Is feature deletion allowed from the UI? Defaults to true. If set to false, users won’t be able to delete features from the UI.

fun[RW]

Public: Are you feeling lucky? Defaults to true. If set to false, users won’t see a videoclip of Taylor Swift when there aren’t any features

nav_items[RW]

Public: An array of nav items to show. By default “Features” and “Settings” are shown, but you can add your own. Each item must have a ‘:title` and `:href` key:

config.nav_items << { title: "Custom", href: "/custom/page" }
read_only[RW]

Public: Is the UI in read only mode or not. Default is false. This supersedes all other write-related options such as (feature_creation_enabled and feature_removal_enabled).

show_feature_description_in_list[RW]

Public: Should feature descriptions be show on the ‘features` list page. Default false. Only works when using descriptions.

Public Class Methods

new() click to toggle source
# File lib/flipper/ui/configuration.rb, line 94
def initialize
  @delete = Option.new("Danger Zone", "Deleting a feature removes it from the list of features and disables it for everyone.")
  @banner_text = nil
  @banner_class = 'danger'
  @feature_creation_enabled = true
  @feature_removal_enabled = true
  @fun = true
  @cloud_recommendation = true
  @add_actor_placeholder = "a flipper id"
  @descriptions_source = DEFAULT_DESCRIPTIONS_SOURCE
  @actor_names_source = DEFAULT_ACTOR_NAMES_SOURCE
  @show_feature_description_in_list = false
  @actors_separator = ','
  @confirm_fully_enable = false
  @confirm_disable = true
  @read_only = false
  @nav_items = [
    { title: "Features", href: "features" },
    { title: "Settings", href: "settings" },
  ]
end

Public Instance Methods

banner_class=(value) click to toggle source
show_feature_description_in_list?() click to toggle source
# File lib/flipper/ui/configuration.rb, line 120
def show_feature_description_in_list?
  using_descriptions? && @show_feature_description_in_list
end
using_descriptions?() click to toggle source
# File lib/flipper/ui/configuration.rb, line 116
def using_descriptions?
  @descriptions_source != DEFAULT_DESCRIPTIONS_SOURCE
end