Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export SVGs #99

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/famous-bobcats-listen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"formidable-oss-badges": patch
---

Export SVGs as featuredLogos
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,18 @@ for the latest available lineup.
- `FigLogBadge`
- `CloudSpliceBadge`

### FeaturedBadge props
### Featured Project Badge props

| Prop | Type | Description | Default |
| ----------- | ------- | --------------------------------------------------------------------------------- | ------- |
| className | String | Additional class names | `''` |
| isHoverable | Boolean | Add hover style effects | `true` |
| simple | Boolean | Hides the description and enlarges the abbreviation - use for small badge display | `false` |

## Featured Logos SVGs

All featured logos are available as SVGs and can be imported as `featuredLogos`

## Examples (with Images)

### ProjectBadge Usage
Expand Down
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ export { default as FeaturedBadge } from "./FeaturedBadge"
export * from "./featuredProjectBadges"

export type FeaturedBadgeNames = keyof typeof featuredLogos.default
export { featuredLogos }
Loading