https://github.com/vaadin/vaadin-progress-bar
The Web Component for customized progress bars. Part of the Vaadin components.
https://github.com/vaadin/vaadin-progress-bar
polymer polymer-element polymer2 progress-bar vaadin web-components webcomponents
Last synced: 6 months ago
JSON representation
The Web Component for customized progress bars. Part of the Vaadin components.
- Host: GitHub
- URL: https://github.com/vaadin/vaadin-progress-bar
- Owner: vaadin
- License: apache-2.0
- Created: 2017-06-29T09:04:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T11:33:12.000Z (9 months ago)
- Last Synced: 2024-11-15T23:31:42.420Z (7 months ago)
- Topics: polymer, polymer-element, polymer2, progress-bar, vaadin, web-components, webcomponents
- Language: HTML
- Homepage: https://vaadin.com/components
- Size: 2.4 MB
- Stars: 6
- Watchers: 14
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# <vaadin-progress-bar>
> ⚠️ Starting from Vaadin 20, the source code and issues for this component are migrated to the [`vaadin/web-components`](https://github.com/vaadin/web-components/tree/master/packages/vaadin-progress-bar) monorepository.
> This repository contains the source code and releases of `` for the Vaadin versions 10 to 19.
[<vaadin-progress-bar>](https://vaadin.com/components/vaadin-progress-bar) is a progress bar Web Component, part of the [Vaadin components](https://vaadin.com/components).
[Live Demo ↗](https://vaadin.com/components/vaadin-progress-bar/html-examples)
|
[API documentation ↗](https://vaadin.com/components/vaadin-progress-bar/html-api)
[](https://www.npmjs.com/package/@vaadin/vaadin-progress-bar)
[](https://github.com/vaadin/vaadin-progress-bar/releases)
[](https://www.webcomponents.org/element/vaadin/vaadin-progress-bar)
[](https://travis-ci.org/vaadin/vaadin-progress-bar)
[](https://coveralls.io/github/vaadin/vaadin-progress-bar?branch=master)
[](https://vaadin.com/directory/component/vaadinvaadin-progress-bar)
[](https://vaadin.com/directory/component/vaadinvaadin-progress-bar)
```html
```
[
](https://vaadin.com/components/vaadin-progress-bar)
## Installation
The Vaadin components are distributed as Bower and npm packages.
Please note that the version range is the same, as the API has not changed.
You should not mix Bower and npm versions in the same application, though.
Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components
are only published on npm, not pushed to GitHub repositories.
### Polymer 2 and HTML Imports Compatible Version
Install `vaadin-progress-bar`:
```sh
bower i vaadin/vaadin-progress-bar --save
```
Once installed, import it in your application:
```html
```
### Polymer 3 and ES Modules Compatible Version
Install `vaadin-progress-bar`:
```sh
npm i @vaadin/vaadin-progress-bar --save
```
Once installed, import it in your application:
```js
import '@vaadin/vaadin-progress-bar/vaadin-progress-bar.js';
```
## Getting started
Vaadin components use the Lumo theme by default.
To use the Material theme, import the correspondent file from the `theme/material` folder.
## Entry points
- The component with the Lumo theme:
`theme/lumo/vaadin-progress-bar.html`
- The component with the Material theme:
`theme/material/vaadin-progress-bar.html`
- Alias for `theme/lumo/vaadin-progress-bar.html`:
- `vaadin-progress-bar.html`
## Running demos and tests in a browser
1. Fork the `vaadin-progress-bar` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) and [Bower](https://bower.io) installed.
1. When in the `vaadin-progress-bar` directory, run `npm install` and then `bower install` to install dependencies.
1. Run `npm start`, browser will automatically open the component API documentation.
1. You can also open demo or in-browser tests by adding **demo** or **test** to the URL, for example:
- http://127.0.0.1:3000/components/vaadin-progress-bar/demo
- http://127.0.0.1:3000/components/vaadin-progress-bar/test
## Running tests from the command line
1. When in the `vaadin-progress-bar` directory, run `polymer test`
## Following the coding style
We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files as well as JavaScript snippets inside `.html` files.
## Big Thanks
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
## Contributing
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
## License
Apache License 2.0
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.