Preview
A simple element that displays information about a github repository.
To use this web component in your project you can utilize one of the following styles of syntax.
/* In an existing JS module / web component */
import '@lrnwebcomponents/github-preview/github-preview.js';
/* At top of an application with build routine */
<script type="module" src="@lrnwebcomponents/github-preview/github-preview.js"></script>
/* Alternatives for top of application */
<script type="module">
import '@lrnwebcomponents/github-preview/github-preview.js';
// imperative form
import {GithubPreview} from '@lrnwebcomponents/github-preview';
// if you don't have a build routine and need to reference directly
import './node_modules/@lrnwebcomponents/github-preview/github-preview.js';
</script>
// via unpkg CDN (good for testing)
<script type="module" src="https://unpkg.com/@lrnwebcomponents/github-preview/github-preview.js"></script>
Run yarn start
will start a local development server, open your default browser to display it, open your finder to the correct window and start watching the /src
directory for changes and automatically rebuilding the element and documentation site for the demo.
$ yarn start
$ yarn run test
Builds ensure that wcfactory can correctly compile your web component project to work on the maximum number of browsers possible.
$ yarn run build
- Fork it!
git clone https://github.com/elmsln/lrnwebcomponents.git
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Preview (and all lrnwebcomponents) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.