@springio/utils

    2.0.1 • Public • Published

    Javascript library with utilities for Spring documentation and websites.

    Usage

    <link rel="stylesheet" type="text/css" href="https://unpkg.com/@springio/utils/style.css" />
    <script async src="https://unpkg.com/@springio/utils"></script>
    

    Block Switcher

    Often used for switching code samples globally between different high level options (Java and Kotlin, Java and XML, YAML and Properties, etc.). If HTML is rendered with Asciidoctor then code snippets like this:

    [source,xml,indent=0,role="primary"]
    .Maven
    ----
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>some-library</artifactId>
        <version>1.2.3</version>
    </dependency>
    ----
    
    [source,indent=0,role="secondary"]
    .Gradle
    ----
    compile 'com.example:some-library:1.2.3'
    ----
    

    Then the HTML will be generated with "title" elements, like this:

    <div class="content primary">
      <div class="title">Maven</div>
      <div class="content">
        <pre>
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>some-library</artifactId>
        <version>1.2.3</version>
    </dependency>
        </pre>
      </div>
    </div>
    <div class="content secondary">
      <div class="title">Gradle</div>
      <div class="content">
        <pre>
    compile 'com.example:some-library:1.2.3'
        </pre>
      </div>
    </div>
    

    The script scans for this kind of structure and re-organizes it so that only one snippet is visible and the others are selectable by a click. It works for all blocks with "Maven|Gradle" choices in the whole document, on the assumption that the user only wants to select this once. It's a bit like classic navigation tabs, but applied to the whole content, not just navigation.

    Publishing

    This library is published in NPMJS (following instructions here). That's how the unpkg.com links work above:

    $ npm login
    $ npm publish --access public
    

    Keywords

    none

    Install

    npm i @springio/utils

    DownloadsWeekly Downloads

    11

    Version

    2.0.1

    License

    Apache-2.0

    Unpacked Size

    8.2 kB

    Total Files

    4

    Last publish

    Collaborators

    • dsyer