{"id":16347992,"url":"https://github.com/ismamz/react-bootstrap-icons","last_synced_at":"2025-04-04T06:08:29.646Z","repository":{"id":36457758,"uuid":"224700817","full_name":"ismamz/react-bootstrap-icons","owner":"ismamz","description":"React component for Bootstrap Icons","archived":false,"fork":false,"pushed_at":"2024-04-11T14:05:26.000Z","size":2922,"stargazers_count":177,"open_issues_count":7,"forks_count":21,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-14T10:57:26.963Z","etag":null,"topics":["bootstrap","icons","react","svg"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ismamz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-28T17:26:32.000Z","updated_at":"2024-06-18T12:42:55.044Z","dependencies_parsed_at":"2024-04-11T14:55:47.703Z","dependency_job_id":null,"html_url":"https://github.com/ismamz/react-bootstrap-icons","commit_stats":{"total_commits":56,"total_committers":7,"mean_commits":8.0,"dds":0.25,"last_synced_commit":"e5729d0e71c09706659b56c7cdb98ef18a080fb8"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismamz%2Freact-bootstrap-icons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismamz%2Freact-bootstrap-icons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismamz%2Freact-bootstrap-icons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ismamz%2Freact-bootstrap-icons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ismamz","download_url":"https://codeload.github.com/ismamz/react-bootstrap-icons/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128746,"owners_count":20888235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","icons","react","svg"],"created_at":"2024-10-11T00:47:55.672Z","updated_at":"2025-04-04T06:08:29.609Z","avatar_url":"https://github.com/ismamz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React Bootstrap Icons\n\nThe brand new [Bootstrap Icons library](https://icons.getbootstrap.com/) to use as React components.\n\n\u003e Currently v1.11.3, over **2000 icons!**\n\n![bootstrap-icons](https://user-images.githubusercontent.com/39626451/192898250-711e2281-ab03-433a-afeb-4ad542b68a5b.png)\n\n## Installation\n\n```bash\nnpm install react-bootstrap-icons --save\n```\n\nor\n\n```bash\nyarn add react-bootstrap-icons\n```\n\n## Usage\n\n```jsx\nimport { ArrowRight } from 'react-bootstrap-icons';\n\nexport default function App() {\n  return \u003cArrowRight /\u003e;\n}\n```\n\nIcons can be configured with inline props:\n\n```jsx\n\u003cArrowRight color=\"royalblue\" size={96} /\u003e\n```\n\nYou can pass whatever props you want:\n\n```jsx\n\u003cArrowRight className=\"ml-4\" /\u003e\n```\n\nYou can also include the whole icon pack:\n\n```jsx\nimport * as Icon from 'react-bootstrap-icons';\n\nexport default function App() {\n  return \u003cIcon.ArrowRight /\u003e;\n}\n```\n\nThe icon names are the `PascalCase` version of the original name. For those icons whose name begins with a number, the `Icon` prefix will be used. Examples: `arrow-right` → `ArrowRight`, `1-circle` → `Icon1Circle`.\n\nYou can also create an `Icon` component and pass it the icon name as a prop:\n\n```jsx\nimport * as icons from 'react-bootstrap-icons';\n\ninterface IconProps extends icons.IconProps {\n  // Cannot use \"name\" as it is a valid SVG attribute\n  // \"iconName\", \"filename\", \"icon\" will do it instead\n  iconName: keyof typeof icons;\n}\n\nexport const Icon = ({ iconName, ...props }: IconProps) =\u003e {\n  const BootstrapIcon = icons[iconName];\n  return \u003cBootstrapIcon {...props} /\u003e;\n}\n```\n\n```jsx\nimport { Icon } from './Icon';\n\nexport default function App() {\n  return (\n    \u003cIcon\n      iconName=\"Stopwatch\"\n      color=\"royalblue\"\n      size={96}\n      className=\"align-top\"\n    /\u003e\n  );\n}\n```\n\n## IconProps\n\n| Name         | Type             | Description                                    |\n| ------------ | ---------------- | ---------------------------------------------- |\n| `color?`     | string           | color of the icon                              |\n| `size?`      | string \\| number | size of the icon (`width` and `height`)        |\n| `title?`     | string           | provides an accessible, short-text description |\n| `className?` | string           | `bi bi-{icon-name}` and add your own classes   |\n\n## Figma Plugin\n\nYou can install it from the Figma app: [Bootstrap Icons Plugin for Figma](https://www.figma.com/community/plugin/868341386266170307/Bootstrap-Icons)\n\n## More options\n\nOther ways to use Boostrap icons: [https://icons.getbootstrap.com/#usage](https://icons.getbootstrap.com/#usage)\n\n## License\n\n- react-bootstrap-icons are open-sourced ([MIT](https://github.com/ismamz/react-bootstrap-icons/blob/master/LICENSE.md))\n- Bootstrap Icons are open-sourced ([MIT](https://github.com/twbs/icons/blob/main/LICENSE)).\n\n## Collaborators\n\n- [@kwnath](https://github.com/kwnath)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fismamz%2Freact-bootstrap-icons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fismamz%2Freact-bootstrap-icons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fismamz%2Freact-bootstrap-icons/lists"}