Documentation

-- header can be used as header on your fastn web projects.

Package Name:

fastn-community.github.io/header

Overview

Logo: Your fastn website logo is placed in the top-left corner of the header. Clicking on the logo leads back to the homepage.
Site Navigation: Primary navigation which called as sections in fastn.sitemap, presented as a horizontal list of links placed in the right side of the logo.
Breadcrumb: is a navigational aid that helps users understand their current location within a website's hierarchical structure. Is placed below logo.
Sub-sections: Secondary navigation which called as sub-sections in fastn.sitemap is placed at the right side of breadcrumb.

Note: The header component is already included inside doc-site. If you are using doc-site then don't add header as fastn dependency.

How to use

Add header dependency into your FASTN.ftd

-- fastn.dependency: fastn-community.github.io/header

Lang:

ftd

Import header into your .ftd file

-- import: fastn-community.github.io/header

-- header.header:
sections: $header.sitemap.sections
site-url: /docs/
site-name: Basic Header

Lang:

ftd

Properties:

Below are details of all properties of this component.

sections

type:

sections list (required)

It's used to show fastn.sitemap sections.

sub-sections

type:

sub-sections list (optional)

It's used to show fastn.sitemap sub-sections.

current-section

type:

current-section title (optional)

It's used to show fastn.sitemap current-section title.

current-subsection

type:

current-subsection title (optional)

It's used to show fastn.sitemap current-subsection title.

current-page

type:

current-page title (optional)

It's used to show fastn.sitemap current-page title.

current-page

type:

current-page title (optional)

It's used to show fastn.sitemap current-page title.

site-url

type:

String (optional)

It’s used to add a site link to your site homepage.

site-name

type:

String (optional)

It’s used to add a site name to header component.

products

type:

List of Records(optional)

Its used to pass products record list to header component. products property will be passed to product-switcher which is imported by default inside header component FASTN.ftd.

login-button

type:

Boolean (optional)

It’s used to enable login button in header component.

login-btn-txt

type:

String ('optional')

It’s used to specify login button text in header component.

login-btn-url

type:

String ('optional')

It’s used to specify login button url in header component.

github-icon

type:

Boolean default: false

It’s used to specify enable GitHub icon button in header component.

github-url

type:

String ('optional')

It’s used to specify github-icon link in header component.

search

type:

Boolean ('optional')

It’s used to enable search button in header component.

search-url

type:

String ('optional')

It’s used to specify search button link in header component.