packages/api-generator/src/locale/en/VNavigationDrawer.json - master - githubmirror/vuetify

packages/api-generator/src/locale/en/VNavigationDrawer.json

30 строк2 KB

Rambaud Pierrick

docs: add description to all the component in the web-types (#22563)

22 апр 2026, 19:19

22 апр 2026, 19:1901b0a53

{
  "description": "Typically used to show application sidebar with navigation.",
  "props": {
    "disableResizeWatcher": "Prevents the automatic opening or closing of the drawer when resized, based on whether the device is mobile or desktop.",
    "disableRouteWatcher": "Disables opening of navigation drawer when route changes.",
    "expandOnHover": "Collapses the drawer to a **rail-variant** until hovering with the mouse.",
    "floating": "A floating drawer has no visible container (no border-right).",
    "image": "Apply a specific background image to the component.",
    "mobileBreakpoint": "Sets the designated mobile breakpoint for the component. This will apply alternate styles for mobile devices such as the `temporary` prop, or activate the `bottom` prop when the breakpoint value is met. Setting the value to `0` will disable this functionality.",
    "permanent": "The drawer remains visible regardless of screen size.",
    "rail": "Sets the component width to the **rail-width** value.",
    "railWidth": "Sets the width for the component when `rail` is enabled.",
    "scrim": "Determines whether an overlay is used when a **temporary** drawer is open. Accepts true/false to enable background, and string to define color.",
    "temporary": "A temporary drawer sits above its application and uses a scrim (overlay) to darken the background.",
    "touchless": "Disable mobile touch functionality.",
    "location": "Controls the edge of the screen the drawer is attached to.",
    "sticky": "When true, the drawer will remain visible when scrolling past the top of the page."
  },
  "slots": {
    "append": "A slot at the bottom of the drawer.",
    "image": "Used to modify `v-img` properties when using the **src** prop.",
    "prepend": "A slot at the top of the drawer"
  },
  "events": {
    "update:rail": "Event that is emitted when the rail model changes."
  },
  "exposed": {
    "isStuck": "Used to determine if the drawer is stuck to the top of the page."
  }
}