chore(fab): explicitly mark function as protected for API docs

PiperOrigin-RevId: 568274397
material-components · Sep 25, 2023 · c789c99 · c789c99
1 parent 1636d91
commit c789c99
Show file tree

Hide file tree

Showing 25 changed files with 35 additions and 24 deletions.
diff --git a/catalog/eleventy-helpers/filters/md-markdown.cjs b/catalog/eleventy-helpers/filters/md-markdown.cjs
@@ -26,6 +26,11 @@ function fixLinks($, redirects) {
 
     let [path, hash] = href.split('#');
 
+    // it's probably a href="#section" link
+    if (path.length === 0) {
+      continue;
+    }
+
     for (const [pattern, replacement] of redirects) {
       const regex = new RegExp(pattern);
       path = path.replace(regex, replacement);

diff --git a/catalog/src/components/nav-drawer.ts b/catalog/src/components/nav-drawer.ts
@@ -230,10 +230,13 @@ import {SignalElement} from '../signals/signal-element.js';
     .pane.toc {
       width: auto;
       box-sizing: border-box;
-      padding-inline: var(--catalog-spacing-xl);
       width: var(--_toc-pane-width);
     }
 
+    .toc .scroll-wrapper {
+      padding-inline: var(--catalog-spacing-xl);
+    }
+
     .pane.toc p {
       margin-block: 0;
       font-size: var(--catalog-label-s-font-size);

diff --git a/docs/components/button.md b/docs/components/button.md
@@ -46,7 +46,7 @@ payment'"
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/buttons) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/button)
     <!-- {.external} -->
 

diff --git a/docs/components/checkbox.md b/docs/components/checkbox.md
@@ -44,7 +44,7 @@ user needs to select one or more options from a list.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/checkbox) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/checkbox)
     <!-- {.external} -->
 

diff --git a/docs/components/chip.md b/docs/components/chip.md
@@ -42,7 +42,7 @@ title="Filter chips">
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/chips) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/chips)
     <!-- {.external} -->
 

diff --git a/docs/components/dialog.md b/docs/components/dialog.md
@@ -38,7 +38,7 @@ title="A dialog">
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/dialogs) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/dialog)
     <!-- {.external} -->
 

diff --git a/docs/components/divider.md b/docs/components/divider.md
@@ -19,7 +19,7 @@ define tappable regions in an accordion.
 ![Screenshot of five stacked dividers](images/divider/hero.png "Dividers separating items in a list.")
 
 *   [Design article](https://m3.material.io/components/divider) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/divider)
     <!-- {.external} -->
 

diff --git a/docs/components/elevation.md b/docs/components/elevation.md
@@ -20,7 +20,7 @@ UI’s elevation story.
 ![Diagram showing the five elevation levels and their respective dp values](images/elevation/hero.png "Material uses six levels of elevation, each with a corresponding dp value. These values are named for their relative distance above the UI’s surface: 0, +1, +2, +3, +4, and +5. An element’s resting state can be on levels 0 to +3, while levels +4 and +5 are reserved for user-interacted states such as hover and dragged.")
 
 *   [Design article](https://m3.material.io/styles/elevation) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/elevation)
     <!-- {.external} -->
 

diff --git a/docs/components/fab.md b/docs/components/fab.md
@@ -88,8 +88,9 @@ payment'"
 <!-- no-catalog-end -->
 <!-- catalog-include "figures/fab/extended-fabs.html" -->
 
-1.  [Extended FAB with both icon and label text](#extended)
-2.  [Extended FAB without icon](#without-icon)
+*   [Extended FAB with both icon and label text](#extended)
+*   [API Documentation](#api)
+*   [Extended FAB without icon](#without-icon)
 
 ## Usage
 

diff --git a/docs/components/figures/select/theming-outlined.html b/docs/components/figures/select/theming-outlined.html
@@ -5,6 +5,9 @@
     aria-label="Image of an outlined select with a different theme applied"
   >
     <style>
+      .figure-wrapper figure {
+        padding-block: 16px;
+      }
       .styled-example {
         background-color: #f4fbfa;
       }
@@ -19,7 +22,6 @@
         --md-menu-container-shape: 0px;
       }
     </style>
-
     <md-outlined-select>
       <md-select-option selected value="apple">
         <div slot="headline">Apple</div>

diff --git a/docs/components/figures/select/usage.html b/docs/components/figures/select/usage.html
@@ -21,7 +21,6 @@
         <div slot="headline">Apricot</div>
       </md-select-option>
     </md-outlined-select>
-
     <md-filled-select>
       <md-select-option aria-label="blank"></md-select-option>
       <md-select-option value="apple">

diff --git a/docs/components/focus-ring.md b/docs/components/focus-ring.md
@@ -18,8 +18,7 @@ to determine when they are visible.
 
 ![Three elements with a focus ring that moves between them.](images/focus/hero.gif "A focus ring moving across elements.")
 
-*   Design article (*coming soon*)
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/focus)
     <!-- {.external} -->
 

diff --git a/docs/components/icon-button.md b/docs/components/icon-button.md
@@ -35,7 +35,7 @@ people take supplementary actions with a single tap.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/icon-buttons) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/iconbutton)
     <!-- {.external} -->
 

diff --git a/docs/components/icon.md b/docs/components/icon.md
@@ -17,7 +17,7 @@ created at seven weights across three different styles.
 ![Array of icons with various stylistic attributes](images/icon/hero.gif)
 
 *   [Design article](https://m3.material.io/styles/icons) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/icon)
     <!-- {.external} -->
 

diff --git a/docs/components/list.md b/docs/components/list.md
@@ -39,6 +39,7 @@ vertical indexes of text and images
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/lists) <!-- {.external} -->
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/list)
     <!-- {.external} -->
 

diff --git a/docs/components/menu.md b/docs/components/menu.md
@@ -40,6 +40,7 @@ choices on a temporary surface.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/menus) <!-- {.external} -->
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/menu)
     <!-- {.external} -->
 

diff --git a/docs/components/progress.md b/docs/components/progress.md
@@ -45,7 +45,7 @@ There are two types of progress indicators: linear and circular.
 
 *   [Design article](https://m3.material.io/components/progress-indicators)
     <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/progress)
     <!-- {.external} -->
 

diff --git a/docs/components/radio.md b/docs/components/radio.md
@@ -37,7 +37,7 @@ people select one option from a set of options.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/radio-button) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/radio)
     <!-- {.external} -->
 

diff --git a/docs/components/ripple.md b/docs/components/ripple.md
@@ -44,7 +44,7 @@ title="A bounded and unbounded ripple.">
 
 *   [Design article](https://m3.material.io/foundations/interaction/states/state-layers)
     <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/ripple)
     <!-- {.external} -->
 

diff --git a/docs/components/select.md b/docs/components/select.md
@@ -38,7 +38,7 @@ selected menu item above the menu.
 </catalog-component-header>
 
 *   Design article (*coming soon*)
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/select)
     <!-- {.external} -->
 

diff --git a/docs/components/slider.md b/docs/components/slider.md
@@ -43,7 +43,7 @@ Sliders can use icons or labels to represent a numeric or relative scale.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/sliders) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/slider)
     <!-- {.external} -->
 

diff --git a/docs/components/switch.md b/docs/components/switch.md
@@ -41,7 +41,7 @@ of an item on or off.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/switch) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/switch)
     <!-- {.external} -->
 

diff --git a/docs/components/tabs.md b/docs/components/tabs.md
@@ -44,7 +44,7 @@ related content that are at the same level of hierarchy.
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/tabs) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/tabs)
     <!-- {.external} -->
 

diff --git a/docs/components/text-field.md b/docs/components/text-field.md
@@ -38,7 +38,7 @@ title="Text fields">
 </catalog-component-header>
 
 *   [Design article](https://m3.material.io/components/text-fields) <!-- {.external} -->
-*   API Documentation (*coming soon*)
+*   [API Documentation](#api)
 *   [Source code](https://github.com/material-components/material-web/tree/main/textfield)
     <!-- {.external} -->
 

diff --git a/fab/internal/fab.ts b/fab/internal/fab.ts
@@ -20,7 +20,7 @@ export class Fab extends SharedFab {
    */
   @property() variant: FabVariant = 'surface';
 
-  override getRenderClasses() {
+  protected override getRenderClasses() {
     return {
       ...super.getRenderClasses(),
       'primary': this.variant === 'primary',