@memoraiz/react-widgets NPM

@memoraiz/react-widgets

A collection of React-based widgets for educational applications, powered by AI-driven functionalities from MemorAIz. This package provides flexible and interactive UI components designed to integrate seamlessly with React projects, enabling developers to easily create engaging user experiences.

Installation

To use the @memoraiz/react-widgets package in your project, ensure you have React version ^17.0 or ^18.0 installed. This package doesn't work yet with React 19 or higher.

Install the package with your preferred package manager:

# yarn install @memoraiz/react-widgets
# pnpm install @memoraiz/react-widgets
npm install @memoraiz/react-widgets

Usage

For detailed information on how to use the components, please refer to the Getting Started guide in the online documentation.

Components

The package includes various UI components designed to be used as widgets in React applications. These components leverage Radix UI and React Aria for accessibility and design flexibility.

Available Components:

Summary: Showcase a summary or a list of keywords and keyphrases extracted from your documents
Flashcard: Display a deck of flashcards that can be flipped to reveal the answer
Quiz: Dislay multiple-choice, true/false and open ended interactive questionaries generated from your documents

Explore the full component documentation for detailed usage instructions.

Development

To develop and test this package locally, clone the repository and run the following commands:

Install Dependencies

yarn install

Build the Package

yarn build

Run in Development Mode

yarn dev

Linting

The package uses ESLint for code quality checks. To lint the project:

yarn lint

Clean

To remove built files and reset the environment:

yarn clean

Contributing

Contributions to the project are welcome! If you encounter any bugs or have feature requests, please file an issue on GitHub. For more significant contributions, feel free to fork the repository and submit a pull request.