Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 1.56 KB

JshCmsRouteProps.md

File metadata and controls

62 lines (36 loc) · 1.56 KB

jsharmony-cms-sdk-react / JshCmsRouteProps

Interface: JshCmsRouteProps

Table of contents

Properties

Properties

bindLinks

Optional bindLinks: boolean

Set to true to convert anchor element to navigate using the React Router instead of standard browser navigation.

This defaults to true. Must be explicitly set to false to prevent link binding.


children

Optional children: ReactElement<any, string | JSXElementConstructor<any>>

The children of this component.


cmsContentPath

Optional cmsContentPath: string | (location: Location<unknown>) => undefined | string

This sets the path of the CMS content to load. E.g., '/about/team.html'. This path will be combined with pageFilesPath set in JshCmsClient

This should not be confused with path.

If this is left empty then the current location.pathname will be used.


component

Optional component: JSXElementConstructor<unknown> | (templateName: string, contentPath: string) => JSXElementConstructor<unknown> | undefined

A component is required to load a dynamic page. This can be left undefined for static HTML pages.


options

Optional options: PublishedContentOptions & (PublishedDynamicContentOptions | PublishedStaticContentOptions)