{"id":13938051,"url":"https://github.com/egoist/aimer-deprecated","last_synced_at":"2025-07-20T00:31:46.309Z","repository":{"id":45274999,"uuid":"108836139","full_name":"egoist/aimer-deprecated","owner":"egoist","description":"The UI Development Framework","archived":true,"fork":false,"pushed_at":"2021-12-25T14:36:39.000Z","size":115,"stargazers_count":41,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-27T06:37:14.071Z","etag":null,"topics":["component","development","framework","react","ui","vue"],"latest_commit_sha":null,"homepage":"","language":"Vue","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/egoist.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":"2017-10-30T10:34:30.000Z","updated_at":"2024-05-20T11:10:05.000Z","dependencies_parsed_at":"2022-08-30T18:30:58.154Z","dependency_job_id":null,"html_url":"https://github.com/egoist/aimer-deprecated","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/egoist/aimer-deprecated","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egoist%2Faimer-deprecated","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egoist%2Faimer-deprecated/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egoist%2Faimer-deprecated/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egoist%2Faimer-deprecated/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/egoist","download_url":"https://codeload.github.com/egoist/aimer-deprecated/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egoist%2Faimer-deprecated/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266048525,"owners_count":23868739,"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":["component","development","framework","react","ui","vue"],"created_at":"2024-08-07T23:04:11.880Z","updated_at":"2025-07-20T00:31:41.287Z","avatar_url":"https://github.com/egoist.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"# Aimer\n\n[![NPM version](https://img.shields.io/npm/v/aimer.svg?style=flat-square)](https://npmjs.com/package/aimer) [![NPM downloads](https://img.shields.io/npm/dm/aimer.svg?style=flat-square)](https://npmjs.com/package/aimer) [![Build Status](https://img.shields.io/circleci/project/egoist/aimer/master.svg?style=flat-square)](https://circleci.com/gh/egoist/aimer) [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000\u0026style=flat-square)](https://github.com/egoist/donate) [![chat](https://img.shields.io/badge/chat-on%20discord-7289DA.svg?style=flat-square)](https://chat.egoist.moe)\n\nThe UI Development Framework, it's so simple that you'll fall in love with.\n\n## Install\n\n```bash\nyarn add aimer --dev\n```\n\n## How to use\n\nAssume you have a component `Button.vue` and you wanna demonstrate it:\n\n```js\nimport Aimer from 'aimer'\nimport 'aimer/dist/aimer.css'\n\n// And the button you wanna demonstrate\nimport MyButton from './path/to/Button.vue'\n\nconst aimer = new Aimer({\n  title: 'optional header title'\n})\n\naimer.add({\n  title: 'With text',\n  component: {\n    template: '\u003cmy-button\u003ehello world\u003c/my-button\u003e',\n    components: {\n      MyButton\n    }\n  },\n  readme: '\u003cp\u003esome html\u003c/p\u003e',\n  example: '...some example code'\n})\n\naimer.add({\n  title: 'With emoji',\n  component: {\n    template: '\u003cmy-button\u003e😄🎉😎👻\u003c/my-button\u003e',\n    components: {\n      MyButton\n    }\n  }\n})\n\n// Start Aimer instance at given node\naimer.start('#app')\n```\n\nRun this script with your favoite bundler of choice, maybe webpack? And you can preview it in the browser:\n\n\u003cimg src=\"https://i.loli.net/2017/10/31/59f826060ee6f.png\" width=\"500\" alt=\"preview\"\u003e\n\nSee it [in action](https://aimer-button.egoist.moe). 🚀\n\n## Work with other frameworks\n\n- [React](./packages/aimer-react)\n- [Preact](./packages/aimer-preact)\n\n## Examples\n\n- [button](https://aimer-button.egoist.moe/)\n- [vue-mugen-scroll](https://egoist.moe/vue-mugen-scroll/)\n\n## API\n\n### new Aimer([options])\n\n#### options\n\n##### title\n\nDefault: `\u003cAimer Logo\u003e`\u003cbr\u003e\nType: `string`\n\nHeader title.\n\n\n##### Adapter\n\nDefault: `AimerVue`\n\nAimer adapter, check out the [default one](./packages/aimer/src/AimerVue.js) for reference.\n\n##### github\n\nType: `string`\n\nGitHub repo slug or URL.\n\n##### twitter\n\nType: `string`\n\nTwitter handle or URL.\n\n### aimer.add(story)\n\n#### story\n\n##### title\n\nType: `string`\u003cbr\u003e\nRequired: `true`\n\nStory title.\n\n##### component\n\nType: `any`\u003cbr\u003e\nRequired: `true`\n\nThe component.\n\n##### example\n\nType: `string`\n\nExample code.\n\n##### readme\n\nType: `HTMLString`\n\nUse as README.\n\n## License\n\nMIT \u0026copy; [EGOIST](https://github.com/egoist)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fegoist%2Faimer-deprecated","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fegoist%2Faimer-deprecated","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fegoist%2Faimer-deprecated/lists"}