{"id":25078113,"url":"https://github.com/ruymon/airway-animation","last_synced_at":"2025-09-07T00:40:44.356Z","repository":{"id":44955283,"uuid":"448457982","full_name":"ruymon/airway-animation","owner":"ruymon","description":"A simple lib to make animate airplanes! ✈","archived":false,"fork":false,"pushed_at":"2022-01-16T06:54:35.000Z","size":19,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T02:49:10.593Z","etag":null,"topics":["class","css-animations","dom-manipulation","javascript","library"],"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/ruymon.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}},"created_at":"2022-01-16T04:36:26.000Z","updated_at":"2022-02-23T01:32:55.000Z","dependencies_parsed_at":"2022-09-09T20:11:36.420Z","dependency_job_id":null,"html_url":"https://github.com/ruymon/airway-animation","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruymon%2Fairway-animation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruymon%2Fairway-animation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruymon%2Fairway-animation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruymon%2Fairway-animation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruymon","download_url":"https://codeload.github.com/ruymon/airway-animation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246580452,"owners_count":20800106,"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":["class","css-animations","dom-manipulation","javascript","library"],"created_at":"2025-02-07T02:49:11.978Z","updated_at":"2025-04-01T03:36:11.325Z","avatar_url":"https://github.com/ruymon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Airway Animation ✈\n\nA concept to add airplanes in a airway using Javascript and CSS Animations. Currently this is a a HTML only concept. In the near future we will add a Lib to abstract this and provide a way to use it in a React App.\n\n## Getting Started\n\n1. Clone the repo\n\n```cmd\ngit clone https://github.com/ruymon/airway-animation.git\n```\n\n_Observation: if you have the [**Github CLI**](https://cli.github.com/) installed you can use the following command to clone the repo._\n\n```cmd\ngh repo clone ruymon/airway-animation\n```\n\n2. Open the index.html file and\n\n3. If you wish to add custom config to the animation, add your configurations in the airway.js file.\n\n```js\nconst customConfig = {\n  // Your Configurations!\n};\n```\n\nAll configurations possibilities:\n\n```js\nconst customConfig = {\n  background: '#282828', // Background color of the container. This property can be a HEX; RGB; RGBA or a color name. If not set, the default background color is transparent.\n  height: 500, // Height of the container as a number. If not set, the deault value is 130px.\n  resizable: false, // Resizable container boolean. If set to true, the container will be resizable.\n  colorFromLeft: 'blue', // Color for the aircraft coming from the left. This property can be a HEX; RGB; RGBA or a color name. If not set, the default color is blue.\n  colorFromRight: 'red', // Color for the aircraft coming from the right. This property can be a HEX; RGB; RGBA or a color name. If not set, the default color is red.\n  lazy: true, // Lazy Mode is a boolean. If set to true, airplanes will spawn slowly (incrementally). If set to false, all airplanes will spawn at once when the page loads.\n  log: false, // Log Mode or Developer Mode. If set to true, the console will log the events. If set to false, the console will not log the events.\n};\n```\n\n### Behind the Scenes 🔎\n\nIn this starter version there is a container div that will be used to inject airplanes.\n\n```html\n\u003cdiv id=\"airwayGrid\"\u003e\u003c/div\u003e\n```\n\n### Roadmap: 📅\n\n---\n\n1. Convert to TypeScript\n\n```ts\ninterface configTypes {\n  background: 'transparent' | string;\n  height: number;\n  resizable: boolean;\n  colorFromLeft: string[] | string | 'random'; // Nice feature to add: 'random'.\n  colorFromRight: string[] | string | 'random'; // Nice feature to add: 'random'.\n  lazy: boolean;\n  log: boolean;\n}\n```\n\n2. Create a Lib to use a component in a React Project:\n\nThis example will demonstrate how this could be used as a component in a React Project:\n\n````jsx\n\n```jsx\nimport React from 'react';\nimport AirwayAnimation from 'airway-animation';\n\nconst config = {\n  maxLimit: 'container',\n  background: 'transparent',\n  resizable: true,\n  colorFromLeft: '#a339e3',\n  colorFromRight: '#2ec662',\n};\n\nfunction sampleData() {\n  return \u003cAirwayAnimation config={config} /\u003e;\n}\n\nexport default sampleData;\n````\n\n---\n\n### Contributing 📝\n\nIf you wish to contribute to this project: _Bug Fixes_; _Updating Docs_; or any update at all, **you can follow this guide:**\n\n- [ ] [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo;\n\n- [ ] Find this fork inside your github project.\n\n- [ ] Create a new _branch_ with your modifications. 💡 _Tip: To create a new branch use the command:_\n\n```git\ngit checkout -b my-branch\n```\n\n- [ ] Make your modifications.\n\n- [ ] _Commit_ your modifications. 💡 _Tip: To commit use the command:_\n\n```cmd\ngit commit -m 'feat: My new feature'\n```\n\n- [ ] _Push_ your _branch_: 💡 _Tip: To push your branch use the command:_\n\n```cmd\ngit push origin my-branch\n```\n\n:tada: Tada! Now the only thing left to do is to open a _pull request_ of your _fork_ and I will be glad to analyze your contribution!;\n\n\u003cbr\u003e\n\n### :memo: Licence\n\nMIT © [Ruy Monteiro](https://github.com/ruymon). This project is under the MIT Licence. Check the [LICENSE](LICENSE) file for more details.\n\n---\n\nMade with ♥ by [Ruy Monteiro](https://github.com/ruymon) :wave:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruymon%2Fairway-animation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruymon%2Fairway-animation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruymon%2Fairway-animation/lists"}