Overview
The Accord Project Cicero UI Library is a collection of React components that can be used to implement contract editing studios. It provides ready-to-use components such as ContractEditor, ErrorLogger, Navigation, ParseResult, and TemplateLoadingClauseEditor. The library is published as an independent npm module and is designed to enhance the contract management and automation process.
Features
- ContractEditor: A functional ReactJS component for a rich text contract editor that supports clause functionality.
- ErrorLogger: A functional ReactJS component for displaying model and logic errors associated with contracts and clauses.
- Navigation: A functional ReactJS component for displaying markdown headings and clause nodes associated with contracts.
- ParseResult: A ReactJS component that provides the ability to fetch and display a collection of library items.
- TemplateLoadingClauseEditor: A component that is still in development and aims to enhance the contract editing experience.
Installation
To install the Accord Project Cicero UI Library, follow these steps:
- Fork the project to your repository.
- Clone the repository to your local machine using
git clone. - Navigate into the directory.
- Run
npm installto install the required dependencies. - Ensure that IBM Plex Sans is imported in your main app’s HTML file using the following link:
<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,500,500i,700" rel="stylesheet">. - Build a production state using
npm run build. - Transpile the code for the build using
npm run transpile. - Create a global link using
npm link. - In your main app directory, run
npm link @accordproject/cicero-uito link the library. - You can now use the Accord Project Cicero UI Library in your project.
Summary
The Accord Project Cicero UI Library is a collection of React components designed for implementing contract editing studios. It provides components like ContractEditor, ErrorLogger, Navigation, ParseResult, and TemplateLoadingClauseEditor that enhance the contract management and automation process. To install the library, fork and clone the project, install the dependencies, and follow the provided installation instructions.