Skip to content

About

A collection of React components that work with Groundwork for the USACE water management community Documentation:

Topics

Resources

Contributing

Stars

3 stars

Watchers

3 watching

Forks

Repository files navigation

Groundwork Water Components

GitHub Release NPM Version GitHub Issues GitHub Pull Requests Last Commit

Getting Started React

npm install @usace-watermanagement/groundwork-water --save

Will install the groundwork water components to your local node_modules directory, and add it to your packages.json for future use.

Import the styles once in your application entry point:

import "@usace-watermanagement/groundwork-water/style.css";

This entry loads Groundwork Water styles and the stylesheet from your installed @usace/groundwork peer dependency. You do not need a separate Groundwork CSS import when using both libraries. The existing /dist/style.css import also works. Import application-specific overrides afterward.

Groundwork CSS alone does not include Groundwork Water's gww- styles. If a Groundwork Water component has missing spacing, colors, or positioning, check that the import above is present. Keep Groundwork within the supported peer dependency range. Matching its stylesheet does not make unsupported component APIs compatible.

This packaging requires Groundwork 4.3.2 or newer within version 4. Applications using Groundwork 3 must upgrade to Groundwork 4 first, or remain on Groundwork Water 4.x. Future Groundwork major versions will need compatibility validation before support is added.

This CSS entry requires a bundler that resolves package CSS imports, such as Vite. It is not a standalone stylesheet for direct browser or CDN linking. It loads the full Groundwork stylesheet, not only the styles for imported components.

Documentation Docs

You can read the current Groundwork Water Documentation:
https://usace-watermanagement.github.io/groundwork-water/

Developers NPM Downloads

If you wish to contribute to the groundwork-water project, and you are a current water management member within USACE, please consider checking out the CONTRIBUTING documentation!

About

A collection of React components that work with Groundwork for the USACE water management community Documentation:

Topics

Resources

Contributing

Stars

3 stars

Watchers

3 watching

Forks

Releases

Used by

Contributors

Languages