1. Home
  2. Globals

Type Definitions

Theme

Description
Color theme objects
Properties
Name Type Attributes Default Description
name string Theme display name
icon string Theme icon
type 'light' | 'dark' Theme type. Must be "light" if the theme uses dark text on a light background or "dark" if the theme uses light text on a dark background.
colors ThemeColors <optional>
 Contains all of the theme colors. This can be omitted if there is CSS for the theme.
isColorTheme boolean <optional>
 false True if this theme is a color theme, false if the theme is black/white/gray.
Details
object

fluid.js, line 27

ThemeColors

Description
An object containing colors for a Fluid UI theme. Each key in the object corresponds exactly to the name of the CSS variable that it sets.
Properties
Name Type Attributes Description
background string Page background color
text string Primary text color
lightText string Color used for slightly less important text (somewhere between text and secText)
secText string Secondary text color
elements string Color used for clickable elements (e.g. buttons, switches, etc.)
elementText string Text color for clickable elements
elementHover string Clickable elements hover color
switchHead string Switch head color
inputColor string Color for input elements (like text boxes)
navbar string Navigation bar color
sidebar string Sidebar background
sidebarActive string Selected sidebar item background
sidenav string Sidenav background
sidenavActive string Selected sidenav item background
cards string Cards color
content string Background used for code blocks and the theme selector. Presented with lightShadow. Somewhere between background and inputColor.
theme string Color used for active items (like enabled switches). This may be overridden (on all themes) to match the site's brand colors.
themeText string Text color used on top of the "theme" color
themeSelectorColor string <optional>
 Text color used when showing this theme in the theme selector in black/white themes. Optional, and should only be used for color themes.
Details
object

fluid.js, line 36

FluidConfig

Description
Contains customization options
Properties
Name Type Attributes Default Description
defaultTheme string <optional>
 system The theme ID to use by default
allowBackgroundImages boolean <optional>
 true Allows the user to set a background image theme
allowedThemes boolean | Array.<string> <optional>
 true Either an array of themeIDs to allow, or true to allow all themes. Light, dark, and system are always allowed.
Details
object

fluid.js, line 107

strings

Description
An object containing all of the strings (or functions if the text is adaptive) for text displayed in the UI. This is provided so that websites can override the text in Fluid UI.
Details
object

fluid.js, line 121

AlertAction

Description
Sets the actions for an alert
Properties
Name Type Description
icon string Action icon
name string Action name
action function The function to run when the action is clicked
Details
object

fluid.js, line 911