https://github.com/vaadin-component-factory/vcf-popup
popup that can be bound to element
https://github.com/vaadin-component-factory/vcf-popup
Last synced: 3 months ago
JSON representation
popup that can be bound to element
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/vcf-popup
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2019-05-02T11:53:24.000Z (about 6 years ago)
- Default Branch: v24
- Last Pushed: 2024-01-12T08:10:42.000Z (over 1 year ago)
- Last Synced: 2025-02-04T23:36:01.177Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 160 KB
- Stars: 1
- Watchers: 9
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# <vcf-popup>
This is the npm version [vcf-popup](https://github.com/vaadin-component-factory/vcf-popup) developed using Polymer 3.
<vcf-popup> is a Web Component providing an easy way to hide extra content from your webpage and show them to the user whenever they need them.
## Demo
https://vcf-popup.netlify.com/
## Installation
Install `vcf-popup`:
```sh
npm i @vaadin-component-factory/vcf-popup --save
```
## Usage
Once installed, import it in your application:
```js
import '@vaadin-component-factory/vcf-popup';
```
Add `vcf-popup` to the page with attribute `for` that match `id` element to which popup should be bind to. Now after clicking on target element, popup will be shown.
```html
[part='container'] {
padding: 5px 10px;
}
```
## Running demo
1. Fork the `vcf-popup` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vcf-popup` directory, run `npm install` to install dependencies.
1. Run `npm start` to open the demo.
## Running tests
### Unit tests
Run `npm test` from command line
### Visual tests
1. Run `npm start` to open the demo.
1. Navigate to `http://localhost:8081/dev/` to open page where you can test features of the Popup
## 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