Skip to content

Commit 5e7cde1

Browse files
committed
docs(api): routerecord.props
1 parent 6b0531e commit 5e7cde1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/api/index.md

+10
Original file line numberDiff line numberDiff line change
@@ -818,6 +818,16 @@ Route record that can be provided by the user when adding routes via the [`route
818818

819819
Before enter guard specific to this record. Note `beforeEnter` has no effect if the record has a `redirect` property.
820820

821+
### props
822+
823+
- **Type**: `boolean | Record<string, any> | (to: RouteLocationNormalized) => Record<string, any>` (Optional)
824+
- **Details**:
825+
826+
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.
827+
target location.
828+
829+
- **See Also**: [Passing props to Route Components](/guide/essentials/passing-props.md)
830+
821831
### meta
822832

823833
- **Type**: [`RouteMeta`](#routemeta) (Optional)

0 commit comments

Comments
 (0)