{"id":30011236,"url":"https://github.com/kristian240/chakra-ui-bottom-navigation","last_synced_at":"2025-08-05T12:55:29.729Z","repository":{"id":48874617,"uuid":"382534878","full_name":"kristian240/chakra-ui-bottom-navigation","owner":"kristian240","description":"Bottom navigation component built for Chakra UI","archived":false,"fork":false,"pushed_at":"2022-09-14T17:37:51.000Z","size":570,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-09T09:32:33.994Z","etag":null,"topics":["bottom-navigation","chakra-ui","chakra-ui-react"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kristian240.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2021-07-03T05:38:56.000Z","updated_at":"2023-08-31T14:58:25.000Z","dependencies_parsed_at":"2022-08-19T14:01:07.394Z","dependency_job_id":null,"html_url":"https://github.com/kristian240/chakra-ui-bottom-navigation","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/kristian240/chakra-ui-bottom-navigation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristian240%2Fchakra-ui-bottom-navigation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristian240%2Fchakra-ui-bottom-navigation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristian240%2Fchakra-ui-bottom-navigation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristian240%2Fchakra-ui-bottom-navigation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kristian240","download_url":"https://codeload.github.com/kristian240/chakra-ui-bottom-navigation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristian240%2Fchakra-ui-bottom-navigation/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268901281,"owners_count":24326069,"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","status":"online","status_checked_at":"2025-08-05T02:00:12.334Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bottom-navigation","chakra-ui","chakra-ui-react"],"created_at":"2025-08-05T12:55:25.262Z","updated_at":"2025-08-05T12:55:29.682Z","avatar_url":"https://github.com/kristian240.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chakra-UI Bottom Navigation\n\nChakra-UI Bottom Navigation is an accessible and reusable component built to work seamlessly with [Chakra-UI](https://chakra-ui.com/).\n\nCheck the [demo](https://codesandbox.io/s/chakra-ui-bottom-navigation-example-kp7hk?file=/src/index.tsx)\n\n## Features\n\n- Multiple variants\n- Easily modifed\n- Composable\n- And more...\n\n## Install\n\n```bash\nnpm install chakra-ui-bottom-navigation\n# or\nyarn add chakra-ui-bottom-navigation\n```\n\n\u003e NOTE: this component requries Chakra-UI \u003e= v1.0.0 to work properly. You can follow [instructions for installing Chakara-UI](https://chakra-ui.com/docs/getting-started) or [instructions for migrating to v1](https://chakra-ui.com/docs/migration)\n\n## Theme\n\nBy default, this component comes with some predefined styles. To utilize this styles add them to theme overrides.\n\n```jsx\nimport { ChakraProvider, extendTheme } from '@chakra-ui/react';\nimport { BottomNavigationStyleConfig as BottomNavigation } from 'chakra-ui-bottom-navigation';\n\nconst theme = extendTheme({\n  components: {\n    BottomNavigation,\n  },\n});\n\nexport const App = () =\u003e {\n  return (\n    \u003cChakraProvider theme={theme}\u003e\n      \u003cApp /\u003e\n    \u003c/ChakraProvider\u003e\n  );\n};\n```\n\n### WithDefaultTheme\n\nIf you want to expand defualt styles of the component, use the `withDefaultStyles` HOC. Component override follows the same structure as all other Chakra-UI components. [Check the guide here.](https://chakra-ui.com/docs/theming/component-style#styling-multipart-components)\n\n```jsx\nimport { withDefaultStyles } from 'chakra-ui-bottom-navigation';\n\nconst bottomNavigationOverries = {\n  // ... component's override\n};\n\nconst MyBottomNavigation = withDefaultStyles(bottomNavigationOverries);\n\nconst theme = extendTheme({\n  components: {\n    BottomNavigation: MyBottomNavigation,\n  },\n});\n```\n\n## Import\n\nChakra-UI Bottom Navigation exports 4 component:\n\n- `BottomNavigation`: The wrapper that provides context for all children.\n- `BottomNavigationItem`: A single Bottom Navigation element\n- `BottomNavigationIcon`: An icon used to render the item\n- `BottomNavigationLabel`: A label used to label an item\n\n## Usage\n\n```jsx\nexport const BasicExample = () =\u003e {\n  const [value, setValue] = useState(0);\n\n  return (\n    \u003cBottomNavigation value={value} onChange={setValue}\u003e\n      \u003cBottomNavigationItem\u003e\n        \u003cBottomNavigationIcon as={HomeIcon} /\u003e\n        \u003cBottomNavigationLabel\u003eHome\u003c/BottomNavigationLabel\u003e\n      \u003c/BottomNavigationItem\u003e\n\n      \u003cBottomNavigationItem\u003e\n        \u003cBottomNavigationIcon as={SearchIcon} /\u003e\n        \u003cBottomNavigationLabel\u003eSearch\u003c/BottomNavigationLabel\u003e\n      \u003c/BottomNavigationItem\u003e\n\n      \u003cBottomNavigationItem\u003e\n        \u003cBottomNavigationIcon as={StarIcon} /\u003e\n        \u003cBottomNavigationLabel\u003eFavourites\u003c/BottomNavigationLabel\u003e\n      \u003c/BottomNavigationItem\u003e\n    \u003c/BottomNavigation\u003e\n  );\n};\n```\n\n### Bottom navigation as app navigation\n\n```jsx\nexport const NavigationExample = () =\u003e {\n  const router = useRouter();\n\n  const handleChange = useCallback(\n    (path) =\u003e {\n      router.push(path);\n    },\n    [router.push]\n  );\n\n  return (\n    \u003cBottomNavigation value={router.pathname} onChange={handleChange}\u003e\n      \u003cBottomNavigationItem value=\"/\"\u003e\n        \u003cBottomNavigationIcon as={HomeIcon} /\u003e\n        \u003cBottomNavigationLabel\u003eHome\u003c/BottomNavigationLabel\u003e\n      \u003c/BottomNavigationItem\u003e\n\n      \u003cBottomNavigationItem value=\"/search\"\u003e\n        \u003cBottomNavigationIcon as={SearchIcon} /\u003e\n        \u003cBottomNavigationLabel\u003eSearch\u003c/BottomNavigationLabel\u003e\n      \u003c/BottomNavigationItem\u003e\n\n      \u003cBottomNavigationItem value=\"/favorites\"\u003e\n        \u003cBottomNavigationIcon as={StarIcon} /\u003e\n        \u003cBottomNavigationLabel\u003eFavorites\u003c/BottomNavigationLabel\u003e\n      \u003c/BottomNavigationItem\u003e\n    \u003c/BottomNavigation\u003e\n  );\n};\n```\n\n## Props\n\n### BottomNavigation props\n\nBottomNavigation composes `Box` so you call pass all `Box` related props.\n\n| Prop name     | Description                                   | Default value | Values                                                 |\n| ------------- | --------------------------------------------- | ------------- | ------------------------------------------------------ |\n| `colorScheme` |                                               | `blue`        | all default chakra-ui `colorSchemes` (can be extended) |\n| `onChange`    | function that is called when item is selected |               |                                                        |\n| `showLabel`   | determines when label should be visible       | `always`      | `'never' \\| 'if-active' \\| 'always'`                   |\n| `value`       | active value of bottom navigation             |               |                                                        |\n\n### BottomNavigationItem props\n\nBottomNavigationItem composes `Button` so you call pass all `Button` related props.\n\n| Prop name | Description                                     | Default value                                 | Values |\n| --------- | ----------------------------------------------- | --------------------------------------------- | ------ |\n| `value`   | Value that will be passed to `onChange` handler | by default, value is set to index of the item |        |\n\n### BottomNavigationIcon props\n\nBottomNavigationItem composes `Icon` so you call pass all `Icon` related props.\n\n### BottomNavigationLabel props\n\nBottomNavigationItem composes `Box` so you call pass all `Box` related props.\n\nEvery `BottomNavigationItem` should have `BottomNavigationLabel` so assistive technologies can label the element. If label is now show (inactive when `showLabel: 'if-active'` or when `showLabel: `'never'`), the label is only hidden from the screen but it is still rendered in the DOM.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkristian240%2Fchakra-ui-bottom-navigation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkristian240%2Fchakra-ui-bottom-navigation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkristian240%2Fchakra-ui-bottom-navigation/lists"}