Neo React Component Library

This is the react version of the shared library called "NEO" buit by Avaya (storybook site)

Install

npm i @avaya/neo-react

or

yarn add @avaya/neo-react

Example Usage

At the root of your application, import the CSS styles via:

import "@avaya/neo-react/avaya-neo-react.css";

Then, simply import the component(s) that you'd like to use, see the documentation site for more examples.

import { IconNamesType, NoContent } from "@avaya/neo-react";

export const Example = () => {
  const agentIconName: IconNamesType = "agent";
  return <NoContent icon={agentIconName} text={"Agent has no content"} />;
};

NOTE: if you are using Astro, add the following to your astro.config.mjs (link to Astro docs on "why" to do this):

export default defineConfig({
  vite: {
    ssr: {
      noExternal: ["avaya-neo-react"],
    },
  },
});

Adding to this library

If you would like to contribute to this project, you can start in our how to dev doc

other readme files

• accessibility guidelines
• coding guidelines
• how to dev
• how to publish
• periphery tech
• pr best practices

License

Copyright 2020-2022 Avaya Inc. All Rights Reserved.