Git Product home page Git Product logo

vaadin-item's Introduction

<vaadin-item>

⚠️ Starting from Vaadin 20, the source code and issues for this component are migrated to the vaadin/web-components monorepository. This repository contains the source code and releases of <vaadin-item> for the Vaadin versions 10 to 19.

<vaadin-item> is a Web Component providing a container for item elements, part of the Vaadin components.

Live Demo ↗ | API documentation ↗

npm version Published on webcomponents.org Published on Vaadin Directory Discord

<vaadin-item>Simple Item</vaadin-item>
<vaadin-item disabled>Disabled Item</vaadin-item>

Screenshot of vaadin-item

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-item:

bower i vaadin/vaadin-item --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vaadin-item/vaadin-item.html">

Polymer 3 and ES Modules Compatible Version

Install vaadin-item:

npm i @vaadin/vaadin-item --save

Once installed, import it in your application:

import '@vaadin/vaadin-item/vaadin-item.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-item.html

  • The component with the Material theme:

    theme/material/vaadin-item.html

  • Alias for theme/lumo/vaadin-item.html:

    vaadin-item.html

Running demos and tests in a browser

  1. Fork the vaadin-item repository and clone it locally.

  2. Make sure you have npm and Bower installed.

  3. When in the vaadin-item directory, run npm install and then bower install to install dependencies.

  4. Run npm start, browser will automatically open the component API documentation.

  5. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

Running tests from the command line

  1. When in the vaadin-item directory, run polymer test

Following the coding style

We are using ESLint 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.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0

vaadin-item's People

Contributors

artur- avatar dependabot[bot] avatar haprog avatar jouni avatar limonte avatar manolo avatar marcushellberg avatar platosha avatar samiheikki avatar sohrabtaee avatar someonetoignore avatar tomivirkki avatar vicsstar avatar vursen avatar web-padawan avatar yuriy-fix avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

vaadin-item's Issues

Introduce a block container for the slotted content

Currently, Lumo specifies the host as a flex container. This might come as a surprise to developers when elements are not wrapped normally but placed on the same line horizontally.

We should consider adding a <div> wrapper for the slotted content.

At the same time, we should consider if we would like to do the same for vaadin-combo-box-item (maybe actually extend vaadin-item). It currently has a wrapper for the label property, and we could just introduce a <slot> inside that (and change it span -> div).

label attribute not bindable

I am unable to bind a value to the label attribute.
It is needed from within a dom-repeat of relatively complex vaadin-item element.

When I try to bind to the label attribute, it gets redlined:

screen shot 2018-09-18 at 22 57 31

So when I do this:

screen shot 2018-09-18 at 22 58 00

It results in this:

screen shot 2018-09-18 at 22 58 12

Whereas the expected result is this:

screen shot 2018-09-18 at 22 59 06

Improve documentation

Documentation for selectable item behavior is a little scarse: what do I need to do? Add tabindex and a click listener?

Also, no mention that keyboard enter & space also toggle the selection

Focusable Item demo broken

The Valo theme sets outline to none so the demo needs to restore it here: instead of just setting the outline-color we need to also set the style and width (probably initial values for those).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.