@avonni/base-components

Base components

Showing:

Popularity

Downloads/wk

50

GitHub Stars

8

Maintenance

Last Commit

3d ago

Contributors

10

Package

Dependencies

2

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Avonni Components

Introduction

Avonni Components are customizable pre-made components built using the Lightning Web Components standards. It allows you to extend the possibilities of what you can create on the Salesforce Platform.

Vision

The Lightning Component Library is an incredible starting point for application development, but with a growing demand for engaging, high-impact business applications, they do not cover all aspects or needs developers are looking for. With Avonni Components, we want to become whatever is generally useful for developing business solutions on the Lightning platform, all in the spirit of the Lightning Web Component framework.

Avonni Components helps:

  • Standardize Lightning development across different projects
  • Reduce maintenance overhead
  • Deliver fully composable Lightning components
  • Build new apps faster

Use Avonni Components Outside of Salesforce Platform

Install the avonni base components package in your project by running yarn or npm install.

// with npm
$ npm install @avonni/base-components

// with yarn
$ yarn add @avonni/base-components

Note: SLDS styles needs to be globally defined at application level.

Use Avonni Components Inside of Salesforce Platform

Go to the Github repo for Salesforce Platform Avonni Base Components SFDX

Deploy to Salesforce

Roadmap and Ideas

Avonni Components Roadmap

Avonni Components Ideas

Testing

We use the Jest JavaScript Testing Framework to author and run component tests.

Documentation

Contributing

We are not accepting contributions at this time but you can share any ideas on our roadmap.

License

Avonni Components is a free and open source project, released under the permissable MIT license. This means it can be used in personal or commercial projects for free.

This documentation content is licensed under the Apache 2 license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100