github-link
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

github-link

A component that allows you to set up a link for github , by simply set a tag.

日本語 | ENGLISH


<script
  src="https://unpkg.com/github-link/dist/esm/github-link.js"
  type="module"
></script>

<github-link url="https://github.com/ivgtr/github-link" />

Demo

demo

Usages

Script tag

  • Set a script tag like this. <script src="https://unpkg.com/github-link/dist/esm/github-link.js" type="module"></script>
  • Call <github-link /> at any place.

Vue

  • Install it with npm i github-link --save
  • Call the loader as follows.
<script>
import { applyPolyfills, defineCustomElements } from 'github-link/loader'

applyPolyfills().then(() => {
  defineCustomElements()
})

export default {
  name: "App"
}
</script>
<templeate>
  <div id="app">
    <github-link url="https://github.com/ivgtr/github-link" />
  </div>
</templeate>

React

  • Install it with npm i github-link --save
  • Call the loader as follows
import { applyPolyfills, defineCustomElements } from 'github-link/loader'

applyPolyfills().then(() => {
  defineCustomElements()
});

export default function App() {
  return (
    <div className="App">
       <github-link url="https://github.com/ivgtr/github-link" />
    </div>
  );
}

Configs

Property Attribute Description Type Default
mode mode Reverse to Lightmode and Darkmode Themes. "normal" | "reverse" 'normal'
url url The Github link you want to configure. string 'https://github.com/'

License

MIT ©ivgtr

Twitter Follow MIT License Donate

Readme

Keywords

none

Package Sidebar

Install

npm i github-link

Weekly Downloads

9

Version

1.0.0

License

MIT

Unpacked Size

292 kB

Total Files

39

Last publish

Collaborators

  • ivgtr