element-boilerplate

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #typescript #golang #rust #linux #macos #windows #kubernetes #vue #pytorch #open-source

element-boilerplate

(★ 275)

Fork this repo if you want to start your own Web Component using VanillaJS

파일 탐색기

최종 버전 다운로드 (.zip)

.editorconfig
.gitignore
bower.json
index.html
my-element.html
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# &lt;my-repo&gt;

> A bare minimum custom element starter-kit using [VanillaJS](http://vanilla-js.com/).
>
> Like [Yeoman](http://yeoman.io/)? Use the [generator-element](https://www.npmjs.org/package/generator-element) instead.
>
> Looking for a working example? Check [hello-world-element](https://github.com/webcomponents/hello-world-element).

## Demo

[Check it live!](http://my-user.github.io/my-repo)

## Install

Install the component using [Bower](http://bower.io/):

```sh
$ bower install my-repo --save
```

Or [download as ZIP](https://github.com/my-user/my-repo/archive/master.zip).

## Usage

1. Import polyfill:

```html
    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
    ```

2. Import custom element:

```html
    <link rel="import" href="bower_components/my-repo/my-element.html">
    ```

3. Start using it!

```html
    <my-element></my-element>
    ```

## Options

Attribute     | Options     | Default      | Description
---           | ---         | ---          | ---
`foo`         | *string*    | `bar`        | Lorem ipsum dolor.

## Methods

Method        | Parameters   | Returns     | Description
---           | ---          | ---         | ---
`unicorn()`   | None.        | Nothing.    | Magic stuff appears.

## Events

Event         | Description
---           | ---
`onsomething` | Triggers when something happens.

## Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

1. Install [bower](http://bower.io/) & [polyserve](https://npmjs.com/polyserve):

```sh
    $ npm install -g bower polyserve
    ```

2. Install local dependencies:

```sh
    $ bower install
    ```

3. Start development server and open `http://localhost:8080/components/my-repo/`.

```sh
    $ polyserve
    ```

## History

For detailed changelog, check [Releases](https://github.com/my-user/my-repo/releases).

## License

[MIT License](http://opensource.org/licenses/MIT)

element-boilerplate

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

element-boilerplate

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README