Package UI

UI ressources for A-Novel apps.

---

Installation

⚠️ Warning: Even though the package is public, GitHub registry requires you to have a Personal Access Token with repo and read:packages scopes to pull it in your project. See this issue for more information.

Make sure you have a .npmrc with the following content (in your project or in your home directory):

@a-novel:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${YOUR_PERSONAL_ACCESS_TOKEN}

Then, install the package using pnpm:

# pnpm config set auto-install-peers true
#  Or
# pnpm config set auto-install-peers true --location project
pnpm add @a-novel/package-ui

Requirements

Create the following mui.d.ts file (make sure it is included in your tsconfig.json):

import type { AgoraUIButtonPropsVariant } from "@a-novel/package-ui/mui";

import "@mui/material";

declare module "@mui/material" {
  //eslint-disable-next-line @typescript-eslint/no-empty-object-type
  interface ButtonPropsVariantOverrides extends AgoraUIButtonPropsVariant {}
}