o-layout JSDoc - Origami Registry

new Layout(layoutElement, options)

Class constructor.

parameter	type	default	description
layoutElement (optional)	HTMLElement		The layout element in the DOM
options (optional)	Object	{}	An options object for configuring aspects of the layout

Methods

constructNavFromDOM - (instance) Construct the sidebar navigation from headings within the DOM.
highlightNavItems(navigation) - (instance) Enables navigation item highlighting based on scroll position. Relies on heading ids and anchor href being the same.
getDataAttributes(layoutElement) - (static) Get the data attributes from the layoutEl. If the layout is being set up declaratively, this method is used to extract the data attributes from the DOM.
init(rootElement, options) - (static) Initialise layout component.

Links

"Layout" class on Github

new LinkedHeading(...)

Represents a linked heading.

Class constructor.

parameter	type	default	description
headingElement	HTMLElement		The heading element in the DOM
options (optional)	Object	{}	An options object for configuring the linked heading
options.content (optional)	String	"¶"	The content to add to the created link
options.title (optional)	String	"Link directly to this section of the page"	The title attribute to add to the created link

Links

"LinkedHeading" class on Github

Layout#constructNavFromDOM

Instance Method

Construct the sidebar navigation from headings within the DOM.

Links

"constructNavFromDOM" function on Github

Layout#highlightNavItems(navigation)

Instance Method

Enables navigation item highlighting based on scroll position. Relies on heading ids and anchor href being the same.

parameter	type	default	description
navigation (optional)	HTMLElement		the sidebar navigation list in the DOM

Links

"highlightNavItems" function on Github

Layout.getDataAttributes(layoutElement)

Static Method

Get the data attributes from the layoutEl. If the layout is being set up declaratively, this method is used to extract the data attributes from the DOM.

parameter	type	default	description
layoutElement	HTMLElement		The layout element in the DOM

Links

"getDataAttributes" function on Github

Layout.init(rootElement, options)

Static Method

Initialise layout component.

parameter	type	default	description
rootElement	HTMLElement \| String		The root element to intialise the layout in, or a CSS selector for the root element
options (optional)	Object	{}	An options object for configuring layout behaviour.

Links

"init" function on Github

new Layout(layoutElement, options)

Class constructor.

parameter	type	default	description
layoutElement (optional)	HTMLElement		The layout element in the DOM
options (optional)	Object	{}	An options object for configuring aspects of the layout

Methods

constructNavFromDOM - (instance) Construct the sidebar navigation from headings within the DOM.
highlightNavItems(navigation) - (instance) Enables navigation item highlighting based on scroll position. Relies on heading ids and anchor href being the same.
getDataAttributes(layoutElement) - (static) Get the data attributes from the layoutEl. If the layout is being set up declaratively, this method is used to extract the data attributes from the DOM.
init(rootElement, options) - (static) Initialise layout component.

Links

"Layout" class on Github

JSDoc: o-layout

new Layout(layoutElement, options)

Methods

Links

new LinkedHeading(...)

Links

Layout#constructNavFromDOM

Instance Method

Links

Layout#highlightNavItems(navigation)

Instance Method

Links

Layout.getDataAttributes(layoutElement)

Static Method

Links

Layout.init(rootElement, options)

Static Method

Links

new Layout(layoutElement, options)

Methods

Links