{"id":18244999,"url":"https://github.com/edgeapp/react-native-airship","last_synced_at":"2025-07-26T21:38:06.776Z","repository":{"id":36308251,"uuid":"223280348","full_name":"EdgeApp/react-native-airship","owner":"EdgeApp","description":"A convenient way to display floating UI over a React Native application","archived":false,"fork":false,"pushed_at":"2024-01-31T05:02:15.000Z","size":836,"stargazers_count":12,"open_issues_count":10,"forks_count":2,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-06-03T15:26:16.751Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/EdgeApp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2019-11-21T22:56:34.000Z","updated_at":"2024-03-30T23:00:39.000Z","dependencies_parsed_at":"2023-12-13T23:29:22.751Z","dependency_job_id":"d05ede4a-b38d-44ce-85be-cf8eaace7340","html_url":"https://github.com/EdgeApp/react-native-airship","commit_stats":{"total_commits":76,"total_committers":5,"mean_commits":15.2,"dds":0.25,"last_synced_commit":"b51763ea1f6db9bcbb744f166b5ca6fc55e3cd0c"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/EdgeApp/react-native-airship","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Freact-native-airship","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Freact-native-airship/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Freact-native-airship/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Freact-native-airship/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EdgeApp","download_url":"https://codeload.github.com/EdgeApp/react-native-airship/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EdgeApp%2Freact-native-airship/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259325582,"owners_count":22841058,"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":[],"created_at":"2024-11-05T09:18:33.434Z","updated_at":"2025-06-11T19:37:26.548Z","avatar_url":"https://github.com/EdgeApp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-native-airship\n\nThe airship floats above your React Native application, providing a place for modals, alerts, menus, toasts, and anything else to appear on top of your normal UI.\n\n\u003cimg alt=\"Glass sheet hovering above phone\" src=\"./docs/isometric.png\" width=\"400\" /\u003e\n\nUnlike React Native's built-in `Modal` component, the airship doesn't block the user from interacting with the application below. The airship has also a simple, promised-based API that lets it easily host multiple children at once. To place an item on the airship, call the `Airship.show` method:\n\n```javascript\nconst answer = await Airship.show(bridge =\u003e (\n  \u003cYesNoModal bridge={bridge} question=\"Do you like questions?\" /\u003e\n))\n```\n\nThe `Airship.show` method returns a promise, so you can simply `await` the user's feedback. This is much simpler than the typical approach of setting up a router and writing custom state handling.\n\nBesides the generic `Airship` container, this library comes with a handful of ready-to-use UI components:\n\n- [AirshipDropdown](./docs/dropdown.md) - A drop-down alert.\n- [AirshipModal](./docs/modal.md) - A slide-up modal which dims the rest of the screen.\n- [AirshipToast](./docs/toast.md) - Emulates the Android Toast component in a cross-platform way.\n\nIf these don't do what you want, you can easily [write your own components](./docs/custom-components.md) to work with Airship.\n\n## Setup\n\nInstall `react-native-airship` using either NPM or yarn:\n\n```sh\nyarn add react-native-airship\n# or:\nnpm i -s react-native-airship\n```\n\nNext, create an Airship instance and place it outside your main scene or router:\n\n```javascript\n// your-app.js:\n\nimport { makeAirship } from 'react-native-airship'\n\nexport const Airship = makeAirship()\n\nexport const App = () =\u003e (\n  \u003cAirship\u003e\n    \u003cYourMainScene /\u003e\n  \u003c/Airship\u003e\n)\n```\n\nNow, anybody in your application can use this `Airship` instance to show things on top of the app:\n\n```javascript\nimport { Airship } from './your-app.js'\n\nAirship.show(bridge =\u003e \u003cAirshipToast bridge={bridge} message=\"Hey!\" /\u003e)\n```\n\nThere is also an `Airship.clear` method that can quickly remove everything mounted on the Airship (useful when logging out, for instance).\n\n## Demo\n\nThis repository includes a [demo application](./AirshipDemo/) you can use to try out the Airship. You will need to run `yarn install` or `npm install` separately in that folder to set up the demo, and then run either `react-native run-android` or `react-native run-ios` to start the demo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgeapp%2Freact-native-airship","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedgeapp%2Freact-native-airship","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgeapp%2Freact-native-airship/lists"}