Terra UI Components
Intro
Forking the Repo
Start by forking the repo on GitHub, then clone it locally and install dependencies.
git clone https://github.com/YOUR_GITHUB_USERNAME/components terra-ui-components
cd terra-ui-components
npm install
Developing
Once you've cloned the repo, run the following command.
npm start
This will spin up the dev server. After the initial build, a browser will open automatically. There is currently no hot module reloading (HMR), as browser's don't provide a way to reregister custom elements, but most changes to the source will reload the browser automatically.
Building
To generate a production build, run the following commands.
npm run build # to build the Lit components
Creating New Components
To scaffold a new component, run the following command, replacing terra-tag-name with the desired tag name.
npm run create terra-tag-name
This will generate source files, a stylesheet, a Jupyter widget, and a docs page for you. When you start the dev server, you'll find the new component in the "Components" section of the sidebar. Do a git status to see all the changes this command made.
Testing Components in Jupyter Lab
Install the uv package manager (https://github.com/astral-sh/uv), it's a lightweight tool that makes working with virtual environments and packages much easier.
Then run the following:
uv venv- create a virtual environment (only have to do this the first time)source .venv/bin/activate- activate ituv pip install -e ".[dev]"- install dependencies (see pyproject.toml)- open base.py and point dependencies to localhost (do not commit these changes) TODO: fix this so we auto-detect local development
npm run start:python- spins up Jupyter lab and should open the browser for you
For an example of how to use the components in a Jupyter Notebook, open the /notebooks/playground.ipynb notebook in Jupyter Lab.
Publishing to NPM and PyPI
The Lit components are available on NPM at: https://www.npmjs.com/package/@nasa-terra/components The Python widgets are available on PyPI: https://pypi.org/project/terra_ui_components/
To build a new version and publish it, you can use NPM commands. The Python equivalents will be run automatically for you (see the "scripts" in package.json for details). You will need access to both repositories in order to publish.
# commit all your changes first
npm version patch # bump the version, you can use "major", "minor", "patch", etc.
npm publish --access=public
License
Terra UI Components were created by the NASA GES DISC team, on top of the amazing library Shoelace.
Shoelace was created by Cory LaViska and is available under the terms of the MIT license.
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file terra_ui_components-0.0.194.tar.gz.
File metadata
- Download URL: terra_ui_components-0.0.194.tar.gz
- Upload date:
- Size: 4.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6eff11611e0dd7331ad55a54827d5e96b42f845da58377a1ad815a0a72093461
|
|
| MD5 |
545d57da4d60c789d6fd0940583f20d4
|
|
| BLAKE2b-256 |
4c1c4894a67209715afec3b3912caf138d25ffd226c30f04269dfa493c833b6f
|
File details
Details for the file terra_ui_components-0.0.194-py3-none-any.whl.
File metadata
- Download URL: terra_ui_components-0.0.194-py3-none-any.whl
- Upload date:
- Size: 30.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
471e91cd3ec4f325132fc2099a981433395724e5c8bc976e399ba64a2945b474
|
|
| MD5 |
dec3f60fab111119b40f0f1a7680cf62
|
|
| BLAKE2b-256 |
f569ab69cbae894f71363d773bcdd98b62c0c4a4637826b4f1a7962798058de4
|
