Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvii147/peoples-banner-for-bangladesh
:bangladesh: Badges & banners to show support for the Bangladeshi students' anti-discrimination movement
https://github.com/alvii147/peoples-banner-for-bangladesh
badges bangladesh banner
Last synced: about 6 hours ago
JSON representation
:bangladesh: Badges & banners to show support for the Bangladeshi students' anti-discrimination movement
- Host: GitHub
- URL: https://github.com/alvii147/peoples-banner-for-bangladesh
- Owner: alvii147
- License: mit
- Created: 2024-08-02T20:15:06.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T02:44:05.000Z (3 months ago)
- Last Synced: 2024-08-07T01:35:34.400Z (3 months ago)
- Topics: badges, bangladesh, banner
- Language: TypeScript
- Homepage:
- Size: 1010 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# People's Banner for Bangladesh :bangladesh:
The project contains badgers and banners that can be used in GitHub profiles and READMEs to show support for the anti-discrimination movement led by the students of Bangladesh against the fascist government.
> If you'd like to request a variation in color, styles, or text for any of these, please don't hestitate to create an issue with details, and I will try my best to accommodate.
## Badge
The following badges can be used on any GitHub profiles or READMEs.
```md
[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/badges/all-eyes-on-bangladesh-badge-red-green.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/badges/all-eyes-on-bangladesh-badge-red-green.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```md
[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/badges/all-eyes-on-bangladesh-badge-yellow-red.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/badges/all-eyes-on-bangladesh-badge-yellow-red.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
## GitHub Banner
The following banners can be used on top of GitHub project READMEs in show solidarity with Bangladeshi students.
```md
[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-black.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-black.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```md
[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-green.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-green.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```md
[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-red.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-red.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```md
[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-white.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
```[![All Eyes On Bangladesh](https://github.com/alvii147/peoples-banner-for-bangladesh/blob/main/github/banner-white.svg)](https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained)
## React Banner
A React banner component is also available to put at the top of any website. The banner offers configurable options, and also includes a close button that uses local storage to retain the closed state.
### Installation
Install the banner directly from this repository:
```bash
npm install 'https://gitpkg.vercel.app/alvii147/peoples-banner-for-bangladesh/react/react-peoples-banner-for-bangladesh?main'
```### Usage
Once installed, you can use it directly in your React app:
```jsx
// App.js
import logo from './logo.svg';
import './App.css';
import PeoplesBannerForBangladesh from 'react-peoples-banner-for-bangladesh';function App() {
return (
);
}export default App;
```The `variant` prop can be set to one of `green`, `black`, `red`, or `white`:
### Web View
![](docs/react-web-screenshot-green.png)
![](docs/react-web-screenshot-black.png)
![](docs/react-web-screenshot-red.png)
![](docs/react-web-screenshot-white.png)
### Mobile View
`variant='green'` | `variant='black'` | `variant='red'` | `variant='white'`
--- | --- | --- | ---
![](docs/react-mobile-screenshot-green.png) | ![](docs/react-mobile-screenshot-black.png) | ![](docs/react-mobile-screenshot-red.png) | ![](docs/react-mobile-screenshot-white.png)### Props
Property | Description | Type | Default
--- | --- | --- | ---
`variant` | Variant of banner | `green`
`backgroundColor` | Background color of banner | `#006A4E`
`foregroundColor` | Foreground color of banner | `#FFD666`
`emphasisColor` | Color of "murdered" text | `#F42A41`
`link` | Redirect link of banner when on click | `https://www.aljazeera.com/program/newsfeed/2024/7/24/bangladeshs-deadly-protests-explained`