Code Monkey home page Code Monkey logo

statamic-anchor-navigation's Introduction

Statamic Anchor Navigation

A Statamic addon that provides a custom tag for creating an anchor nav for all headings generated by the bard editor.

Features

  • Extends the TipTap heading node and adds a slugified ID to all configured heading levels (defaults to h2).
  • The {{ anchor_navigation }} tag makes it easy to build an anchor navigation for all headings within your bard content.

How to install

Run the following command from your project root:

composer require visuellverstehen/statamic-anchor-navigation

How to use

Include the {{ anchor_navigation }} tag in your template and supply the field handle of your bard field.

<ul>
    {{ anchor_navigation from="bard" }}
        <li>
            <a href="#{{ id }}">{{ headline }}</a>
        </li>
    {{ /anchor_navigation }}
</ul>

You also specify the entry from which you want to render the anchor navigation.

<ul>
    {{ anchor_navigation from="bard" :entry="specific_entry" }}
        <li>
            <a href="#{{ id }}">{{ headline }}</a>
        </li>
    {{ /anchor_navigation }}
</ul>

You can get the amount of headings found within the content with the count tag:

{{ if {anchor_navigation:count from="bard"} > 0 }}
    ...
{{ /if }}

Configurations

You can define which heading levels should be included in your anchor navigation. Level 2 headings are set as a default.

'heading' => [
    'levels' => [2],
],

More about us

License

The MIT license (MIT). Please take a look at the license file for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.