NOTE: This package contains components that are not currently stable. They may be incomplete or change significantly without notice, therefore are not recommended for consumption by others at this time.
React components and utils for the Tekton Dashboard's pipeline visualisations
To install @tektoncd/dashboard-graph in your project, you will need to run the following
command using npm:
npm install -S @tektoncd/dashboard-graphIf you prefer Yarn, use the following command instead:
yarn add @tektoncd/dashboard-graphYou will also need to install the Carbon packages which provide the base styling and components:
See the @tektoncd/dashboard-components documentation for details of setting up Sass for styling.
To use a component, you can import it directly from the package:
import { Graph } from '@tektoncd/dashboard-graph';
function MyComponent() {
return <Graph edges={…} nodes={…} />;
}To include the styles for the graph components:
@import '@tektoncd/dashboard-graph/src/components/newGraph.scss';This will likely be separated out in future so that styles for each component can be imported separately.
For a full list of components available, checkout our Storybook.
If you're looking for @tektoncd/dashboard-graph API documentation, check out:
We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. Code samples are licensed under the Apache 2.0 License.