docs(api): routerecord.props

diff --git a/docs/api/index.md b/docs/api/index.md
index 00eaafc6330f44db11328f2e950bed72f3248afe..91be993f116f2092d6ce8c95e3b868ffc6db89ad 100644 (file)
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -818,6 +818,16 @@ Route record that can be provided by the user when adding routes via the [`route
 
   Before enter guard specific to this record. Note `beforeEnter` has no effect if the record has a `redirect` property.
 
+### props
+
+- **Type**: `boolean | Record<string, any> | (to: RouteLocationNormalized) => Record<string, any>` (Optional)
+- **Details**:
+
+  Allows passing down params as props to the component rendered by `router-view`. When passed to a _multiple views record_, it should be an object with the same keys as `components` or a `boolean` to be applied to each component.
+  target location.
+
+- **See Also**: [Passing props to Route Components](/guide/essentials/passing-props.md)
+
 ### meta
 
 - **Type**: [`RouteMeta`](#routemeta) (Optional)