Skip to content

Vonage/vivid

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Repository files navigation

Quality

Vivid UI components

Vivid provides a Design System comprised of ready-to-use web components and services, aligned with the Vonage's design guidelines, providing well-thought APIs and striving to stick to the best practices in every possible aspect.

Demos, tutorials and living examples are at vivid.vonage.com.

Our architectural approach in general is here.

Contributor guidance is here.


Consumption

Our deliveries are available as GitHub packages, they are privately accessible within Vonage organization.

Please visit Vivid packages page to enlist our latest releases. You may further drill into each package to read its specific documentation, review previous versions etc.

GitHub packages may be consumed via various build systems, please refer to this documentation for more details.

Obviously, most likely Vivid products will be consumed as npm dependencies in package.json, specific documentation on that is located here.


Roadmap

The system contains these aspects:

  • general services/facilities (fonts management, scheme management etc)
  • atomic/generic components
  • high level business-logic specific components

The overall roadmap may be split into the the following:

  • alpha (0.0.x versions; alpha-romeo :)) - initial release (month to few months?), deliverables of this release are likely to have breaking changes
    • establishing infra of the CI/CD, deployment space for development and for production
    • establishing a process of feedback-based delivery in a short loops, levereging GitHub issues engine for feedback and discussion
    • actual delivery of a few simple base elements as for an early feedback collection and establishing overall design pattern to be expected by the consuming community
  • beta (0.x.x versions; bugatti :)) - wide and verify release (few months?), deliverables of this release are expected to be stable from API perspective
    • applying the feedback collected from the alpha release
    • adding more components to the pool
    • finalizing anything API related
  • GA (1.x.x versions; ) - first stable release
    • APIs are finalized and any future breaking changes will require deprecation-removal cycle
    • all of the basic components are implemented
    • some of the high-level components implemented

As part of our 'go to market' plan, we are focusing first on the essential components, those that are already exist in Volta and used. Quick transition of Volta's components towards Vivid's ones will allow us early-feedback/early-treatment, incremental development and prevent double development and future re-write of the new components.

Common
Component Package Status Issues
vvd-fonts GPR GA Issues
vvd-scheme GPR GA Issues
Generic/Atomic components
Component Package Status Issues
<vwc-button> GPR GA Issues
<vwc-callout> - planned Issues
<vwc-checkbox> GPR GA Issues
<vwc-chip> - in progress Issues
<vwc-drawer> GPR in progress Issues
<vwc-dropdown> - planned Issues
<vwc-fab> - in progress Issues
<vwc-formfield> GPR GA Issues
<vwc-icon> GPR GA Issues
<vwc-linear-progress> GPR GA Issues
<vwc-list> GPR GA Issues
<vwc-menu> GPR in progress Issues
<vwc-modal> - planned Issues
<vwc-radio> GPR GA Issues
<vwc-scheme-select> GPR in progress Issues
<vwc-select> GPR GA Issues
<vwc-slider> GPR GA Issues
<vwc-switch> GPR GA Issues
<vwc-table> - planned Issues
<vwc-textfield> GPR GA Issues
<vwc-textarea> GPR GA Issues
High level Vonage specific components
Component Package Status Issues
<vwc-carousel> GPR GA Issues
<vwc-dialer> - planned Issues
<vwc-file-picker> GPR GA Issues
<vwc-media-controller> GPR GA Issues
<vwc-video> - planned Issues

Issues

We use GitHub Issues as the official bug tracker for Vivid Please check the existing issues. It's possible someone has already reported the same problem.

If your problem or idea is not addressed yet, open a new issue.


Suggestions

Go through the board to search for existing feedbacks and share yours if not already addressed.