API Documentation

NavigationSchema extends PageSchema

Front matter schema interfaces are used by various Hyde components to specify what data they provide or contain. They also serve as a convenient way to see the supported front matter properties.

Tags
see
NavigationData
see
HydePage

Table of Contents

Constants

NAVIGATION_SCHEMA  = [ 'label' => 'string', // The text to display 'priority' => 'int', // Order is also supported 'hidden' => 'bool', // Visible is also supported (but obviously invert the value) 'group' => 'string', ]
PAGE_SCHEMA  = [ 'title' => 'string', 'description' => 'string', // For <meta name='description'> values. It is used by the automatic page metadata generator, which reads this value from the front matter. 'canonicalUrl' => 'string', // While not present in the page data as a property, it is used by the accessor method, which reads this value from the front matter. 'navigation' => \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema::NAVIGATION_SCHEMA, ]

Constants

NAVIGATION_SCHEMA

public mixed NAVIGATION_SCHEMA = [ 'label' => 'string', // The text to display 'priority' => 'int', // Order is also supported 'hidden' => 'bool', // Visible is also supported (but obviously invert the value) 'group' => 'string', ]

PAGE_SCHEMA

public mixed PAGE_SCHEMA = [ 'title' => 'string', 'description' => 'string', // For <meta name='description'> values. It is used by the automatic page metadata generator, which reads this value from the front matter. 'canonicalUrl' => 'string', // While not present in the page data as a property, it is used by the accessor method, which reads this value from the front matter. 'navigation' => \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema::NAVIGATION_SCHEMA, ]

        
On this page

Search results