ui-components

This repository aims to ease the creation of voting interfaces for user-facing applications. The purpose is to allow developers to easily integrate a variety of voting flow components and style these components as desired.

Included Packages

Component	Description
	Voting-related React components and providers for easy Vocdoni integration.
	A set of custom wallets for rainbowkit.
	Package extending our SDK functionalities (for advanced usage).

The best place to learn about using ui-components packages is the developer portal.

Table of Contents

• Getting Started
• Reference
• Examples
• Preview
• Disclaimer
• Contributing
• License

Getting Started

Each of these packages can be used in a typescript/javascript project by importing them, eg. pnpm add @vocdoni/react-components. Follow the developer documentation, or go to each individual package's readme file, for further details.

Each package has a TypeScript entrypoint configured, so you can run pnpm dev from the included ui-scaffold template to develop and validate changes across the monorepo.

If you link (via pnpm link) any of the included packages to your project, your project MUST be able to run typescript code. Otherwise it will fail.

Turbo was initially configured for the development process, but its usage is minimal; still, you can use it for some global commands:

• pnpm build: will build every package in the monorepo (including templates)
• pnpm clean: removes dist, .turbo and node_modules folders in the entire monorepo.
• pnpm lint: runs the linter of each package (may vary per package, but usually prettier & tsc).
• pnpm test: runs all package tests in the monorepo through Turbo and Vitest.

To run commands for a single package, use pnpm --filter:

• pnpm --filter @vocdoni/react-components build
• pnpm --filter @vocdoni/rainbowkit-wallets lint
• pnpm --filter @vocdoni/extended-sdk test

Reference

The developer portal includes a reference for the @vocdoni/react-components package.

Examples

You can find mock-functional examples of election-related components in the ui-components documentation. There is also real-world usage of many components and providers from this library in the ui-scaffold codebase, including a full theme customization example in src/theme/react-components.

Preview

In addition to the live examples in the documentation, you can see many of the components in use at https://app.vocdoni.io/

Disclaimer

This project is a WIP and is subject to continuous changes during its development. We encourage you to review this repository and the developer portal for any changes.

Contributing

While we welcome contributions from the community, we do not track all of our issues on Github and we may not have the resources to onboard developers and review complex pull requests. That being said, there are multiple ways you can get involved with the project.

Please review our development guidelines.

License

This repository is licensed under the GNU Affero General Public License v3.0.

Vocdoni UI React Components
Copyright (C) 2024 Vocdoni Association

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.