Customisation
Styling
You can customize the widget’s appearance by setting your own custom theme or using our default dark
or light
mode themes. Specify the following properties in the config
object.
FKAppearance Interface
All colors should be given in their hex value.
Property | Type | Description |
---|---|---|
themeColor | string | undefined | The primary theme color for the UI (e.g., '#2D2D2D' ). |
textColor | string | undefined | The color used for text elements (e.g., '#2D2D2D' ). |
backgroundColor | string | undefined | The widget’s background color (e.g., '#ffffff' ). |
highlightColor | string | undefined | The color used for highlighted elements (e.g., '#F0F0F0' ). |
borderColor | string | undefined | The color used for borders in the UI (e.g., '#2D2D2D' ). |
logoUrl | string | null | URL for the logo to be displayed (e.g., 'https://example.com/logo.png' ). |
dark | Colors | undefined | An object containing color configurations for dark mode (e.g., { themeColor: '#FFF' } ). |
roundness | number | undefined | The border radius for UI components (e.g., 42 ). |
theme | ThemeName | The name of the theme to be used (e.g., ThemeName.Light ). |
ThemeName
ThemeName
is an Enum with three values: Dark, Light, and System. To apply a theme, choose from the following:
- For dark theme, use
ThemeName.Dark
- For light theme, use
ThemeName.Light
- For system theme, use
ThemeName.System
Colors Interface
If you mention below color specifically it will overwrite the default theme of widget.
The Colors
interface is used both in the main FKAppearance interface and in its dark
property. It contains the following properties:
Property | Type | Description |
---|---|---|
themeColor | string | undefined | The primary theme color for the UI (e.g., '#2D2D2D' ). |
textColor | string | undefined | The color used for text elements (e.g., '#2D2D2D' ). |
backgroundColor | string | undefined | The widget’s background color (e.g., '#ffffff' ). |
highlightColor | string | undefined | The color used for highlighted elements (e.g., '#F0F0F0' ). |
borderColor | string | undefined | The color used for borders in the UI (e.g., '#2D2D2D' ). |