https://github.com/vaadin-component-factory/vcf-field-description

https://github.com/vaadin-component-factory/vcf-field-description

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vaadin-component-factory/vcf-field-description
• Owner: vaadin-component-factory
• License: apache-2.0
• Created: 2021-08-18T01:41:48.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-09-07T05:52:57.000Z (over 3 years ago)
• Last Synced: 2025-02-10T03:06:47.845Z (3 months ago)
• Language: TypeScript
• Size: 347 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# <vcf-field-description>

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![npm version](https://badgen.net/npm/v/@vaadin-component-factory/vcf-field-description)](https://www.npmjs.com/package/@vaadin-component-factory/vcf-field-description)

[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/field-description)

This is the npm version [vcf-field-description](https://github.com/vaadin-component-factory/vcf-field-description) developed using LitElement.

![screenshot](https://github.com/vaadin-component-factory/vcf-field-description/blob/main/.github/images/screenshot1.png)

## Build

```sh

npm install

npm run build

```

## Installation

Install `vcf-field-description`:

```sh

npm i @vaadin-component-factory/vcf-field-description --save

```

## Usage

Once installed, import it in your application:

```js

import '@vaadin-component-factory/vcf-field-description';

```

Add `` to the page. 

## 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