https://github.com/hackclub/banner

⛳ React component for adding a Hack Club banner to your site
https://github.com/hackclub/banner

hackclub react

Last synced: 15 days ago
JSON representation

⛳ React component for adding a Hack Club banner to your site

• Host: GitHub
• URL: https://github.com/hackclub/banner
• Owner: hackclub
• License: mit
• Created: 2019-01-06T20:25:27.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-26T23:10:01.000Z (over 1 year ago)
• Last Synced: 2025-02-14T05:10:03.831Z (over 1 year ago)
• Topics: hackclub, react
• Language: JavaScript
• Homepage: https://hackclub.com/banner
• Size: 1000 KB
• Stars: 8
• Watchers: 7
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# `@hackclub/banner`

> React component for adding a [Hack Club](https://hackclub.com) banner to your club site

[![npm](https://img.shields.io/npm/v/@hackclub/banner.svg)](https://www.npmjs.com/package/@hackclub/banner) [![CI](https://github.com/hackclub/banner/actions/workflows/ci.yml/badge.svg)](https://github.com/hackclub/banner/actions/workflows/ci.yml)

## Install

Use npm or yarn as follows:

```bash

npm install --save @hackclub/banner

yarn add @hackclub/banner

```

## Usage

Place `` anywhere on your club site homepage.

```jsx

import Banner from '@hackclub/banner'

export default () => (

  

    

    
Hacking High School Hack Club

  

)

```


### Custom props

```jsx

```

  

    Prop

    Effect

  

  

    year

    Number. Default: current year

  

  

    style

    Object, for custom styles

  

## License

MIT © [Hack Club](https://hackclub.com)