fix(slides): document custom properties

references #14850
ionic-team · Aug 27, 2018 · ecf1eb8 · ecf1eb8
1 parent 7356ba5
commit ecf1eb8
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/core/src/components/slides/readme.md b/core/src/components/slides/readme.md
@@ -70,6 +70,14 @@ Licensed under MIT
 | `update`           | Update the underlying slider implementation. Call this if you've added or removed child slides. |
 
 
+## CSS Custom Properties
+
+| Name                         | Description                                |
+| ---------------------------- | ------------------------------------------ |
+| `--bullet-background`        | Background of the pagination bullets       |
+| `--bullet-background-active` | Background of the active pagination bullet |
+
+
 ----------------------------------------------
 
 *Built with [StencilJS](https://stenciljs.com/)*
diff --git a/core/src/components/slides/slides.scss b/core/src/components/slides/slides.scss
@@ -5,6 +5,13 @@
 // --------------------------------------------------
 
 :host {
+  /**
+   * @prop --bullet-background: Background of the pagination bullets
+   * @prop --bullet-background-active: Background of the active pagination bullet
+   */
+
+  // TODO: document progress and scroll bar properties once they're working
+
   display: block;
 
   user-select: none;