docs(dashboard): add docs for named and index colors (apache#30445)

preset-io · Oct 1, 2024 · d1d9011 · d1d9011
1 parent 9f476b2
commit d1d9011
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/docs/docs/faq.mdx b/docs/docs/faq.mdx
@@ -174,13 +174,16 @@ You can take a look at this Flask-AppBuilder
 ## Is there a way to force the dashboard to use specific colors?
 
 It is possible on a per-dashboard basis by providing a mapping of labels to colors in the JSON
-Metadata attribute using the `label_colors` key.
+Metadata attribute using the `label_colors` key. You can use either the full hex color, a named color,
+like `red`, `coral` or `lightblue`, or the index in the current color palette (0 for first color, 1 for
+second etc). Example:
 
 ```json
 {
     "label_colors": {
-        "Girls": "#FF69B4",
-        "Boys": "#ADD8E6"
+        "foo": "#FF69B4",
+        "bar": "lightblue",
+        "baz": 0
     }
 }
 ```