Skip to content

Commit

Permalink
updated readme, added screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
GH Pages Bot committed Jan 7, 2020
1 parent ac10865 commit 8db0318
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 4 deletions.
49 changes: 46 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,69 @@
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/lit-place-input) [![npm version](https://badge.fury.io/js/whatsapp-button.svg)](https://badge.fury.io/js/lit-place-input)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/lit-place-input) [![npm version](https://badge.fury.io/js/lit-place-input.svg)](https://badge.fury.io/js/lit-place-input)

[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]

# \<lit-place-input>

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
A simple and fully customizable [Place Autocomplete](https://developers.google.com/places/web-service/autocomplete) component.

Checkout the [Storybook here ↗](https://smashah.github.io/)


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

[<img src="https://raw.githubusercontent.com/smashah/lit-place-input/master/screenshot.png" alt="Screenshot of whatsapp-button" width="800">](https://smashah.github.io/lit-place-input/?path=/story/litplaceinput--simple)

## Installation

```bash
npm i lit-place-input
Or
yarn add lit-place-input
```

then import

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

Or grab from [unpkg.com CDN](https://unpkg.com/lit-place-input?module):

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


## Usage

<!--
```
<custom-element-demo>
<template>
<script src="https://unpkg.com/lit-place-input?module" type="module"></script>
<script type="module">
import 'lit-place-input/lit-place-input.js';
</script>
<next-code-block></next-code-block>
</template>
</custom-element-demo>
```
-->

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

<lit-place-input></lit-place-input>
<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
```bash
npm run lint
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@
},
"repository": {
"type": "git",
"url": "https://github.com/smashah/whatsapp-button.git"
"url": "https://github.com/smashah/lit-place-input.git"
}
}
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8db0318

Please sign in to comment.