{"id":20045638,"url":"https://github.com/actav-n/floating-icon-navigation","last_synced_at":"2025-05-05T09:31:01.767Z","repository":{"id":181242145,"uuid":"665788658","full_name":"ActaV-N/floating-icon-navigation","owner":"ActaV-N","description":"React navigation component package","archived":false,"fork":false,"pushed_at":"2023-08-01T01:03:57.000Z","size":1466,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-12T12:55:15.000Z","etag":null,"topics":["fin","floating-icon-navigation","navigation","navigation-component","react-navigation","reactjs","reactjs-component"],"latest_commit_sha":null,"homepage":"https://actav-n.github.io/floating-icon-navigation/","language":"TypeScript","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/ActaV-N.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-13T02:30:17.000Z","updated_at":"2023-12-07T08:03:32.000Z","dependencies_parsed_at":"2023-07-14T16:49:38.511Z","dependency_job_id":null,"html_url":"https://github.com/ActaV-N/floating-icon-navigation","commit_stats":null,"previous_names":["actav-n/floating-icon-navigation"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActaV-N%2Ffloating-icon-navigation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActaV-N%2Ffloating-icon-navigation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActaV-N%2Ffloating-icon-navigation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActaV-N%2Ffloating-icon-navigation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ActaV-N","download_url":"https://codeload.github.com/ActaV-N/floating-icon-navigation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224436095,"owners_count":17310778,"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":["fin","floating-icon-navigation","navigation","navigation-component","react-navigation","reactjs","reactjs-component"],"created_at":"2024-11-13T11:18:19.385Z","updated_at":"2024-11-13T11:18:20.460Z","avatar_url":"https://github.com/ActaV-N.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Floating-icon-navigation\n\n![npm](https://img.shields.io/npm/v/%40actav%2Ffloating-icon-navigation)\n![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/actav-n/floating-icon-navigation/publish.yml)\n![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/ActaV-N/floating-icon-navigation)\n![NPM](https://img.shields.io/npm/l/%40actav%2Ffloating-icon-navigation)\n\n\n\n[**Live Demo**](https://actav-n.github.io/floating-icon-navigation/)\n\nEx)\n\n![Screen Recording 2023-07-15 at 1 21 05 AM](https://github.com/ActaV-N/floating-icon-navigation/assets/26318387/8346f7bb-cd15-437e-b67b-81d79d5351af)\n\n# Installation\n\n```sh\nyarn add @actav/floating-icon-navigation\n```\n\nor\n\n```sh\nnpm install @actav/floating-icon-navigation\n```\n\n# Usage\n\n## Provider\n\nWrap your App with Fin `Provider`\n\n```ts\n// ... some imports\nimport { FinProvider } from '@actav/floating-icon-navigation';\n\nReactDOM.createRoot(document.getElementById('root')!).render(\n  \u003cReact.StrictMode\u003e\n    \u003cFinProvider\u003e\n      \u003cApp /\u003e\n    \u003c/FinProvider\u003e\n  \u003c/React.StrictMode\u003e,\n);\n```\n\n## Components\n\n### Fins, Fin: Content Generator\n\n```ts\n// ... some imports\nimport { Fins, Fin } from '@actav/floating-icon-navigation';\n\nfunction Generator() {\n  // There should be at least one Fin component with index\n  return (\n    \u003cFins\u003e\n      \u003cFin index path='main' activeColor='#4263EB' icon={\u003cAiFillHome /\u003e}\u003e\n        Home\n      \u003c/Fin\u003e\n      \u003cFin path='git' icon={\u003cAiFillGithub /\u003e}\u003e\n        Visit{' '}\n        \u003ca href='https://github.com/ActaV-N/floating-icon-navigation' target='_blank' rel='noopener'\u003e\n          repository\n        \u003c/a\u003e\n      \u003c/Fin\u003e\n      \u003cFin path='info' activeColor='#40C057' icon={\u003cAiFillExclamationCircle /\u003e}\u003e\n        This package is created by Lee\n      \u003c/Fin\u003e\n    \u003c/Fins\u003e\n  );\n}\n\nexport default Generator;\n```\n\nAbovce code will make this:\n\n\u003cimg width=\"235\" alt=\"Screenshot 2023-07-15 at 1 18 34 AM\" src=\"https://github.com/ActaV-N/floating-icon-navigation/assets/26318387/418226c1-94d2-4228-91d9-42e8c195ed7a\"\u003e\n\n### FinReceiver: Content Receiver\n\n```ts\n// ... some imports\nimport { FinReceiver } from '@actav/floating-icon-navigation';\n\nfunction Receiver() {\n  return (\n    \u003cdiv\u003e\n      \u003cFinReceiver /\u003e\n      \u003cGenerator /\u003e\n    \u003c/div\u003e\n  );\n}\n\nexport default Receiver;\n```\n\nIf you add receiver, result will be like this:\n\n\u003cimg width=\"343\" alt=\"Screenshot 2023-07-15 at 1 18 39 AM\" src=\"https://github.com/ActaV-N/floating-icon-navigation/assets/26318387/84c8217a-2b56-4dbf-a7c6-b0094a4795b0\"\u003e\n\n## Props\n\n### Fin\n|  **props**  |                                                          **description**                                                         |     **type**    |\n|:-----------:|:--------------------------------------------------------------------------------------------------------------------------------:|:---------------:|\n| icon        | icon component, representing navigation button                                                                                   | React.ReactNode |\n| activeColor | css color string like hex, '#fff' or RGBA, 'rgba(255, 255, 255, 1)'. This activeColor will be applied when the fin is activated. | string?         |\n| index       | Default fin. It's optional property but **at least one \u003cFin/\u003e should be a index**                                                | bolean?         |\n| path        | path for navigation. It's like ID.                                                                                               | string          |\n| children    | children of \u003cFin/\u003e will be shown in Receiver.                                                                                    | React.ReactNode |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factav-n%2Ffloating-icon-navigation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factav-n%2Ffloating-icon-navigation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factav-n%2Ffloating-icon-navigation/lists"}