{"id":13576711,"url":"https://github.com/SeanMcP/astro-emoji","last_synced_at":"2025-04-05T08:32:49.939Z","repository":{"id":60091827,"uuid":"540457401","full_name":"SeanMcP/astro-emoji","owner":"SeanMcP","description":"🚀 An accessible Emoji component for Astro applications","archived":false,"fork":false,"pushed_at":"2022-12-01T13:58:07.000Z","size":374,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-31T00:51:15.374Z","etag":null,"topics":["a11y","accessibility","astro","astro-component","emoji"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/astro-emoji","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/SeanMcP.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-09-23T13:38:21.000Z","updated_at":"2025-02-07T03:34:41.000Z","dependencies_parsed_at":"2023-01-22T11:00:50.506Z","dependency_job_id":null,"html_url":"https://github.com/SeanMcP/astro-emoji","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeanMcP%2Fastro-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeanMcP%2Fastro-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeanMcP%2Fastro-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SeanMcP%2Fastro-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SeanMcP","download_url":"https://codeload.github.com/SeanMcP/astro-emoji/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247311953,"owners_count":20918340,"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":["a11y","accessibility","astro","astro-component","emoji"],"created_at":"2024-08-01T15:01:13.097Z","updated_at":"2025-04-05T08:32:49.549Z","avatar_url":"https://github.com/SeanMcP.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# astro-emoji\n\n[![npm](https://img.shields.io/npm/v/astro-emoji.svg)](https://npmjs.com/package/astro-emoji) [![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/astro-emoji.svg)](https://npmjs.com/package/astro-emoji) [![npm](https://img.shields.io/npm/dt/astro-emoji.svg)](https://npmjs.com/package/astro-emoji)\n\n🚀 An accessible Emoji component for Astro applications\n\n## Why?\n\nEmojis can add a light playfulness to your project but require some specific formatting in order to ensure they are accessible for all users. `astro-emoji`'s reusable `Emoji` component helps you do that quickly and painlessly.\n\n## Installation\n\nAdd `astro-emoji` to your project:\n\n```sh\nnpm install astro-emoji\n# or\nyarn add astro-emoji\n```\n\n## Use\n\nImport the default `Emoji` from `astro-emoji` and add it to your code:\n\n```astro\n---\nimport Emoji from 'astro-emoji';\n---\n\n\u003cfooter\u003e\n    Made with\n    {' '}\n    \u003cEmoji symbol=\"💕\" label=\"love\" /\u003e\n    {' '}\n    by Sean McPherson\n\u003c/footer\u003e\n```\n\nThe resulting markup for that component signature will be:\n\n```html\n\u003cspan aria-label=\"love\" role=\"img\"\u003e💕\u003c/span\u003e\n```\n\n`Emoji`s with no `label` prop are rendered with `aria-hidden=\"true\"`:\n\n```astro\n\u003cEmoji symbol=\"🤐\" /\u003e\n\u003c!-- Renders --\u003e\n\u003cspan aria-hidden=\"true\" role=\"img\"\u003e🤐\u003c/span\u003e\n```\n\n## Emoji component\n\nThe `Emoji` component consumes two props: `symbol` and `label`. Every other prop is spread to the top-level `\u003cspan\u003e` element.\n\n### Forbidden properties\n\nThe following properties are managed internally, and therefore ignored if passes as props to `Emoji`:\n\n- `aria-hidden`\n- `aria-label`\n- `role`\n\nThe main benefit of using `astro-emoji` is that you don't need to worry about setting these HTML attributes correctly yourself.\n\n## License\n\n[MIT](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSeanMcP%2Fastro-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSeanMcP%2Fastro-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSeanMcP%2Fastro-emoji/lists"}