@nuclei-components/page-sections

    0.6.2 • Public • Published

    Page-Sections

    A simple section solution for your single page or landing page. Vanilla js, no framework dependencies, small footprint. You can easily specify the sections within the container element to be full screen or define a max width. Additionally functionality makes it easy to navigate the sections conveniently.

    Spec Custom Elements V1 Build Status npm Known Vulnerabilities npm license

    Demo

    Page Sections

    Installation

    npm install --save page-sections

    As the support for web components is currently still pretty spotty, you probably want to load a polyfill before loading the web component.

    I recommend the webcomponentsjs. To make sure the webcomponent is only loaded once the polyfill is done (when using the webcomponents-loader.js) you will want to wait for the WebComponentsReady event before loading the web component. This event is always fired, even in browser that fully support web components.

    <script type="text/javascript" async>
      window.addEventListener('WebComponentsReady', function () {
        let script = document.createElement('script')
        script.setAttribute('src', '../dist/page-sections.js')
        document.head.appendChild(script)
      })
    </script> 

    Usage

    Add one or multiple <page-sections></page-sections> elements to your page. Within you can add as many <page-section></page-section> elements, as you want.

    <page-sections>
        <page-section class="anyClass">
          <div class="red">Your red copy.</div>
        </page-section>
        <page-section>
          <div class="truth">Web components are awesome.</div>
        </page-section>
        <div class="blue">Divs will be ignored</div>
        <page-section>
          <div class="wow">This is so simple.</div>
        </page-section>
    </page-sections>

    The page-section element is a flexbox container with a flex-direction: column. If you want to have items side by side you should add a wrapping container around those items.

    <page-section>
      <div class="grid">
        <div class="column-5">Column 1</div>
        <div class="column-5">Column 2</div>
      </div>
    </page-section>

    Attributes

    <page-section>

    requiredVisible

    The requiredVisible attribute is a value between 0 and 1 representing the percentage that is required to be within the viewport for a page-section to be considered visible. If not set it will default to 0.6.

    centered

    The centered attribute makes the content of a page-section horizontally and vertically centered. The centering is flexbox based so you can overwrite this behaviour if you only want the content to be centered in one direction.

    fullscreen

    If the fullscreen attribute is set on a page-section, it fills at least the entire height of the viewport (min-height: 100vh).

    maxwidth

    This attribute makes the content of a page-section not extend past the specified max-width. Any value that works for max-width will be accepted.

    minwidth

    This attribute makes the content of a page-section extend at least to the specified min-width. Any value that works for min-width will be accepted.

    width

    This attribute makes the content of a page-section have a specified width. Any value that works for width will be accepted.

    active

    When the page-section is in view according to the requiredVisible attribute the active attribute will be added to the page-section element. Once it is not in view anymore it will be removed again.

    activated

    Once the page-section has been in view once, the activated attribute is added to the page-section element.

    Methods

    <page-sections> container

    next

    When evoked, the next method moves the section that follows the currently active section within the selected <page-sections> element into view.

    This method uses the scrollIntoView function with a smooth behaviour which defaults to instant if not supported.

      let sections = document.querySelector('page-sections')
      sections.next() // moves to the next section

    previous

    When evoked, the previous method moves the section that is above the currently active section within the selected <page-sections> element into view.

    This method uses the scrollIntoView function with a smooth behaviour which defaults to instant if not supported.

      let sections = document.querySelector('page-sections')
      sections.previous() // moves to the previous section

    goTo

    When evoked, the goTo method moves the section with the specified name attribute within the selected <page-sections> element into view. Thus the goTo method only works for sections that have a name attribute set on them.

    This method uses the scrollIntoView function with a smooth behaviour which defaults to instant if not supported.

      let sections = document.querySelector('page-sections')
      sections.goTo('sectionName') // moves to the <page-section name="sectionName">

    Events

    <page-section>

    activated

    The activated event is fired when the page-section is in view according to the requiredVisible attribute.

    deactivated

    The deactivated event is fired when the page-section leaves the view according to the requiredVisible attribute.

    <page-sections> container

    activated

    The activated event is fired when the page-sections container is partly visible.

    deactivated

    The deactivated event is fired when the page-sections container has completely left the viewport.

    activateSection

    The activateSection event is fired when a page-section inside the page-sections container is set to active.

    The event details event.detail are:

    • section, the activated section
    • sectionName, the name attributes value of the section (if any)
    • sectionIndex, the index (starting from 1) of the active section within the current sections container. This only takes into account other page-section elements.

    deactivateSection

    The deactivateSection event is fired when the active state of a page-section inside the page-sections container is removed.

    The event details event.detail are:

    • section, the activated section
    • sectionName, the name attributes value of the section (if any)
    • sectionIndex, the index (starting from 1) of the active section within the current sections container. This only takes into account other page-section elements.

    Available CSS Custom Properties

    The page-section has an inner element to allow your content to be centered.

    <page-section>
      <!-- Shadow -->
      <div id="content">
        <slot><!-- Your content is added here --></slot>
      </div>
      <!-- Shadow -->
    </page-section>

    In some cases it might be necessary to define a height or width for this element. To this end you have the following css custom properties available.

    width: var(--page-section-width, auto);
    height: var(--page-section-height, auto);
    min-width: var(--page-section-min-width, auto);
    min-height: var(--page-section-min-height, auto);
    max-width: var(--page-section-max-width, auto);
    max-height: var(--page-section-max-height, auto);

    If you wanted your element to be at least 400px wide, you could do the following:

    <style media="screen">
      .min-400{
        --page-section-min-width: 400px;
      }
    </style> 
    <page-section class="min-400">
      Your content.
    </page-section>

    Install

    npm i @nuclei-components/page-sections

    DownloadsWeekly Downloads

    10

    Version

    0.6.2

    License

    MIT

    Unpacked Size

    90.9 kB

    Total Files

    19

    Last publish

    Collaborators

    • lukasoppermann