Git Product home page Git Product logo

react-github-corner's Introduction

react-github-corner

NPM version Dependency Status devDependency Status

NPM

Description

Add a Github banner to your project page. A React version of:

Getting Started

Install the module with: npm install --save react-github-corner

Usage

import React, { Component } from 'react';
import GithubCorner from 'react-github-corner';
export default class MyApp extends Component {
  render() {
    return (
      <div>
        <header>Wow</header>
        <div>Cool</div>
        <footer>Neat</footer>
        <GithubCorner href="https://github.com/username/repo" />
      </div>
    );
  }
}

Documentation

Here are the props you can pass to the GithubCorner instance:

Property Name Type Default Value Description
href String '/' The link to your project page
size Number or String 80 The width and height of the banner
direction String 'right' Whether the banner shows up on the right or left
octoColor String '#fff' The CSS color of the Octocat
bannerColor String '#151513' The CSS color of the banner
ariaLabel String 'Open GitHub project' The aria-label for a11y support
className String undefined Additional class names to be merged with the github-corner default
svgStyle Object undefined Custom styles to apply to the main svg element

Any additional props will be added to the <a /> tag that is rendered. For instance, you can do:

<GithubCorner style="display:none" />

and the style attribute will be rendered (which will hide the element).

Links

License

Copyright (c) 2015 skratchdot
Licensed under the MIT license.

react-github-corner's People

Contributors

dawsbot avatar elrumordelaluz avatar panmona avatar shinychang avatar skratchdot avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.