vizro icon indicating copy to clipboard operation
vizro copied to clipboard

Create a new Vizro component (harder)

Open maxschulz-COL opened this issue 4 months ago • 0 comments

New components

Vizro is always looking to expand its components - and we would be interested to see what new components you guys would like to contribute! Contributing a component is not an easy task, as the API, the styling, and the general functionality need to be discussed and thought through.

For GHC, but also for other contributors - we cannot guarantee that the PR will be merged, but we will assure that we take the contribution into consideration, and if the component should make it to Vizro in the future, then we will try to pick up previous work on it. If a new component is successfully built, but potentially not ready for merge, we would love to feature it in our custom component label and on our Hugging Face community contribution page.

What to do

  • Take a look at our models - they contain the components that need to be built. A good example of a fairly isolated component without too much interaction is the vm.Card.
  • Pick a component you would like to build - see below for some inspiration
  • Contribute the component to the codebase, probably in the components folder and showcase the fuctionality in an example app
  • (optional) Showcase your component as a custom component on Huggingface or PyCafe - you would need to copy the component into a custom component, reach out to us if that is unclear

Potential components

Even more advanced:

maxschulz-COL avatar Oct 02 '24 07:10 maxschulz-COL