Camunda UI Library

A library of reusable UI components for Camunda applications.

Table of Contents

• Installation
• Usage
• Components
• Publishing
• Contributing
• License
• Contact

Installation

To install the camunda-ui-library, run the following command:

npm install camunda-ui-library

Usage

To install the camunda-ui-library, run the following command:

npm install camunda-ui-library

Add @import 'camunda-ui-library/dist/style.css'; to your index.css file

Components

import { Button } from "camunda-ui-library";

<Button variant='button-primary' >Button</Button>

<Button variant='button-secondary' >Button</Button>

<Button variant='button-tertiary' >Cancel</Button>

Publishing

Set Up an Azure DevOps Organization:

If you don’t already have an Azure DevOps organization, you’ll need to create one. You can do this by visiting the Azure DevOps website.

Create a Project:

Within your Azure DevOps organization, create a new project where you will manage your npm packages.

Create a Feed:

Navigate to Artifacts in your Azure DevOps project.

Create a new feed where your npm packages will be stored.

Configure npm to Use Your Feed:

You need to configure your local npm client to use the Azure Artifacts feed. You can do this by running the following command in your terminal:

npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false vsts-npm-auth -config .npmrc

This will generate an .npmrc file in your project directory with the necessary authentication details.

Publish Your Package:

Ensure your package.json file is correctly set up with the necessary details for your npm package. Run the following command to publish your package to the Azure Artifacts feed:

npm publish --registry

Replace with the URL of your Azure Artifacts feed. e.g. camundaUILibraryArtifacts

To publish the camunda-ui-library, run the following command:

npm publish --registry camundaUILibraryArtifacts

Contributing

Arun Kamble

License

MIT

Contact

vodafone.com