https://github.com/manolo/foo-element
Foo Element
https://github.com/manolo/foo-element
Last synced: 3 months ago
JSON representation
Foo Element
- Host: GitHub
- URL: https://github.com/manolo/foo-element
- Owner: manolo
- License: apache-2.0
- Created: 2018-07-30T08:47:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-14T15:37:05.000Z (over 7 years ago)
- Last Synced: 2025-09-15T01:20:45.495Z (4 months ago)
- Language: HTML
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.webcomponents.org/element/vaadin/foo-element)
[](https://travis-ci.org/vaadin/foo-element)
[](https://coveralls.io/github/vaadin/foo-element?branch=master)
[](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://vaadin.com/directory/component/vaadinfoo-element)
[](https://vaadin.com/directory/component/vaadinfoo-element)
# <foo-element>
[Live Demo ↗](https://vaadin.com/components/foo-element/html-examples)
|
[API documentation ↗](https://vaadin.com/components/foo-element/html-api)
[<foo-element>](https://vaadin.com/components/foo-element) is a Web Component providing <element-functionality>, part of the [Vaadin components](https://vaadin.com/components).
```html
...
```
[
](https://vaadin.com/components/foo-element)
## 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 `foo-element`:
```sh
bower i vaadin/foo-element --save
```
Once installed, import it in your application:
```html
```
### Polymer 3 and ES Modules compatible version
Install `foo-element`:
```sh
npm i @vaadin/foo-element --save
```
Once installed, import it in your application:
```js
import '@vaadin/foo-element/foo-element.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/component-name.html`
- The component with the Material theme:
`theme/material/component-name.html`
- Alias for `theme/lumo/component-name.html`:
`component-name.html`
## Running demos and tests in browser
1. Fork the `foo-element` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `foo-element` directory, run `npm install` and then `bower install` to install dependencies.
1. Make sure you have [polymer-cli](https://www.npmjs.com/package/polymer-cli) installed globally: `npm i -g polymer-cli`.
1. Run `polymer serve --open`, 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:8080/components/foo-element/demo
- http://127.0.0.1:8080/components/foo-element/test
## Running tests from the command line
1. When in the `foo-element` 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 `gulp lint`, which will automatically lint all `.js` files as well as JavaScript snippets inside `.html` files.
## 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.