Skip to content

A simple and fully customizable place autocomplete component extending @mwc-textfield, following open-wc recommendations.

License

Notifications You must be signed in to change notification settings

smashah/lit-place-input

Repository files navigation

Published on webcomponents.org npm version

Buy me a coffee

<lit-place-input>

A simple and fully customizable Place Autocomplete component.

Checkout the Storybook here ↗

<lit-place-input .apiKey=${"APIKEY"} label="Choose Place"></lit-place-input>

Screenshot of whatsapp-button

Installation

> npm i lit-place-input
Or
> yarn add lit-place-input

then import

<script type="module">
  import 'lit-place-input/lit-place-input.js';
</script>

Or grab from unpkg.com CDN:

<script src="https://unpkg.com/lit-place-input?module" type="module"></script>

Usage

<lit-place-input apiKey="AIzaSyCQjwnft-x6cXQYDkGNYBzaevanW3mVNBA" label="Choose Place"></lit-place-input>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint
npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint
npm run format:prettier

Testing with Karma

To run the suite of karma tests, run

npm run test

or to run them in compatibility mode for legacy browsers

npm run test:compatibility

To run the tests in watch mode (for TDD, for example), run

npm run test:watch

or

npm run test:compatibility

Testing with Karma via BrowserStack

To run the suite of karma tests in BrowserStack, run

npm run test:bs

Managing Test Snapshots

You can manage the test snapshots using

npm run test:update-snapshots

or

npm run test:prune-snapshots

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Local Demo with es-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html

npm start:compatibility

To run a local development server in compatibility mode for older browsers that serves the basic demo located in demo/index.html

About

A simple and fully customizable place autocomplete component extending @mwc-textfield, following open-wc recommendations.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published