alpha

This version is in early development and is subject to change and therefore not ready for wide use. There may be other stable versions available.

Progress indicator github location npm version

Element showing progress of an action. Can be used with helper text to show the user what the progress is.


Variants


Usage

Takes percentage as a parameter and renders progress as filled bar. If percentage is not provided, it will be set to 0.

Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "block",
  "progressPercent": 30,
  "width": "14rem"
}
 %}
{% include "../path_to/vf-progress-indicator/vf-progress-indicator.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-progress-indicator', {
  "component-type": "block",
  "progressPercent": 30,
  "width": "14rem"
} %}
                
HTML
<div role="progressbar" aria-valuenow="30" aria-valuemin="0" aria-valuemax="100" class="vf-progress-indicator" style="--vf-progress-indicator__width: 14rem">
  <div class="vf-progress-indicator__mark" style="--vf-progress-indicator__percent: 30%"></div>
</div>
              

Some helper text

Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "block",
  "helperText": "Some helper text",
  "progressPercent": 70,
  "width": "14rem"
}
 %}
{% include "../path_to/vf-progress-indicator/vf-progress-indicator.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-progress-indicator', {
  "component-type": "block",
  "helperText": "Some helper text",
  "progressPercent": 70,
  "width": "14rem"
} %}
                
HTML
<div role="progressbar" aria-valuenow="70" aria-valuemin="0" aria-valuemax="100" class="vf-progress-indicator" style="--vf-progress-indicator__width: 14rem">
  <div class="vf-progress-indicator__mark" style="--vf-progress-indicator__percent: 70%"></div>
  <p class="vf-progress-indicator__helper-text">Some helper text</p>
</div>
              
Installation info

This repository is distributed with [npm][https://www.npmjs.com/]. After [installing npm][https://www.npmjs.com/get-npm] and yarn, you can install vf-progress-indicator with this command.

$ yarn add --dev @visual-framework/vf-progress-indicator

JS

NO JS yet.

Sass/CSS

The style files included are written in Sass. If you're using a VF-core project, you can import it like this:

@import "@visual-framework/vf-progress-indicator/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.1.13

  • Documentation updates
  • New release

1.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-progress-indicator

Find an issue on this page? Propose a change or discuss it.