{"id":20489128,"url":"https://github.com/avaya-dux/neo-react-library","last_synced_at":"2025-04-13T16:21:40.988Z","repository":{"id":59711189,"uuid":"524209108","full_name":"avaya-dux/neo-react-library","owner":"avaya-dux","description":"A React implementation of the Avaya Neo Design system. Written in TS.","archived":false,"fork":false,"pushed_at":"2025-01-27T01:57:24.000Z","size":5215,"stargazers_count":7,"open_issues_count":9,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-27T12:47:49.251Z","etag":null,"topics":["avaya","neo","react","typescript","vite","vitest"],"latest_commit_sha":null,"homepage":"https://design.avaya.com/docs/setup","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/avaya-dux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-3rd-party.html","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,"publiccode":null,"codemeta":null}},"created_at":"2022-08-12T19:55:40.000Z","updated_at":"2025-01-20T14:55:50.000Z","dependencies_parsed_at":"2023-12-22T17:26:42.817Z","dependency_job_id":"4bd3e314-1a37-448a-998c-7a5ffe774490","html_url":"https://github.com/avaya-dux/neo-react-library","commit_stats":{"total_commits":176,"total_committers":8,"mean_commits":22.0,"dds":0.5738636363636364,"last_synced_commit":"bd95a3c56fb0464cf0b94b81390d7367bd1d8c9d"},"previous_names":[],"tags_count":105,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avaya-dux%2Fneo-react-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avaya-dux%2Fneo-react-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avaya-dux%2Fneo-react-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avaya-dux%2Fneo-react-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avaya-dux","download_url":"https://codeload.github.com/avaya-dux/neo-react-library/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248741845,"owners_count":21154386,"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":["avaya","neo","react","typescript","vite","vitest"],"created_at":"2024-11-15T17:11:21.821Z","updated_at":"2025-04-13T16:21:40.769Z","avatar_url":"https://github.com/avaya-dux.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Netlify Status](https://api.netlify.com/api/v1/badges/825502d6-02db-45a6-88bc-6aed064eb748/deploy-status)](https://app.netlify.com/sites/neo-react-library-storybook/deploys)\n![github workflow status](https://github.com/avaya-dux/neo-react-library/actions/workflows/run-yarn.yml/badge.svg)\n[![npm version](https://badge.fury.io/js/@avaya%2Fneo-react.svg)](https://badge.fury.io/js/@avaya%2Fneo-react)\n![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joe-s-avaya/e90dadd4c95bbcf46094100f6591134e/raw/code-coverage.json)\n\n# Neo React Component Library\n\n\u003e This is the React version of the shared library called \"NEO\" buit by Avaya ([storybook site](https://neo-react-library-storybook.netlify.app/))\n\n## Install\n\n```bash\nnpm i @avaya/neo-react\n```\n\n```bash\nyarn add @avaya/neo-react\n```\n\n```bash\npnpm add @avaya/neo-react\n```\n\n## Example Usage\n\nAt the root of your application, import the CSS styles via:\n\n```javascript\nimport \"@avaya/neo-react/avaya-neo-react.css\";\n```\n\nThen, simply import the component(s) that you'd like to use, see [the documentation site](https://design.avayacloud.com/components/web) for more examples.\n\n```tsx\nimport { IconNamesType, NoContent } from \"@avaya/neo-react\";\n\nexport const Example = () =\u003e {\n  const agentIconName: IconNamesType = \"agent\";\n  return \u003cNoContent icon={agentIconName} text={\"Agent has no content\"} /\u003e;\n};\n```\n\nNOTE: if you are using [Astro](https://astro.build/), add the following to your `astro.config.mjs` ([link to Astro docs on \"why\" to do this](https://docs.astro.build/en/guides/styling/#import-a-stylesheet-from-an-npm-package)):\n\n```javascript\nexport default defineConfig({\n  vite: {\n    ssr: {\n      noExternal: [\"avaya-neo-react\"],\n    },\n  },\n});\n```\n\n**NOTE**: The Neo CSS Library is included with the Neo React Library. If you install the Neo React Library, you _do not_ need to install or import from the CSS Library.\n\n## Project Recommendations\n\n### [Vite w/ TS](https://vitejs.dev/guide/)\n\nThis team has experience building projects (both apps and libraries) using [CRA (create-react-app)](https://create-react-app.dev/), [Vite](https://vitejs.dev/), [Webpack](https://webpack.js.org/), [Parcel](https://parceljs.org/), and [Rollup](https://www.rollupjs.org/guide/en/). Of those, we recommend using Vite to build out brand-new projects. Vite has shown itself to be not only a faster build tool, but also to be a better DX (Developer eXperience) due to its excellent documentation and intelligent defaults. [See this article](https://blog.logrocket.com/vite-3-vs-create-react-app-comparison-migration-guide/) for some further details on those points.\n\nExample app creation with Vite using React+TS: `pnpm create vite my-react-ts-app --template react-ts`\n\nThis team also has experience building projects with the package managers NPM, [Yarn (classic)](https://classic.yarnpkg.com/lang/en/docs/install/), and [PNPM](https://pnpm.io/installation). Of the three, we have had good experiences with both Yarn (classic) and PNPM and recommend either of those.\n\n## Adding to this library\n\nIf you would like to contribute to this project, you can start in our [how to dev doc](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/how-to-dev.md)\n\n## other readme files\n\n- [accessibility guidelines](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/accessibility-guidelines.md)\n- [coding guidelines](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/coding-guidelines.md)\n- [how to dev](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/how-to-dev.md)\n- [how to publish](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/how-to-publish.md)\n- [periphery tech](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/periphery-tech.md)\n- [pr best practices](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/pr-best-practices.md)\n\n## License\n\nCopyright 2020-2024 Avaya Inc. All Rights Reserved.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favaya-dux%2Fneo-react-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favaya-dux%2Fneo-react-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favaya-dux%2Fneo-react-library/lists"}