Installation

npm install --save @uiw/react-github-corners# Via Yarn:yarn add @uiw/react-github-corners

npm install --save @uiw/github-corners

<scripttype="module"src="https://unpkg.com/@uiw/github-corners?module"></script>

<scripttype="module"src="https://cdn.skypack.dev/@uiw/github-corners"></script>

Usage

importGitHubCornersfrom'@uiw/react-github-corners';functionDemo(){return(<GitHubCornersposition="left"href="https://github.com/uiwjs/react-github-corners"/>)}

<github-cornerstarget="__blank"position="fixed"href="https://github.com/uiwjs/react-github-corners"></github-corners>

importReactfrom'react';import'@uiw/github-corners';functionDemo(){return(<github-cornerstarget="__blank"position="fixed"href="https://github.com/uiwjs/react-github-corners"></github-corners>);}

React Props

interfaceGitHubCornersPropsextendsReact.AnchorHTMLAttributes<HTMLAnchorElement>{/**   * The link to your project page.   */href?:string;/**   * The width and height of the corner.   * Default: `80`   */size?:number;/**   * The background color of the corner.   * Default: `#151513`   */bgColor?:string;/**   * The Github logo color of the corner.   * Default: `#fff`   */color?:string;/**   * The position of corner.   * Default: `right`   */position?:'left'|'right';/**   * It is positioned relative to the initial containing block established.   * Default: `false`   */fixed?:boolean;/**   * Sets the z-order of a positioned element and its descendants or flex items.   */zIndex?:number;}

Development

# Step 1, run first, listen to the component compile and output the .js filenpm run hoist# Step 2, listen for compilation output type .d.ts filenpm run watch:wcnpm run watch# Step 3, development mode, listen to compile preview website instancenpm run start

npm run build:allnpm run doc

Contributors

License