Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Headless Support to UI #493

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

jbouder
Copy link
Collaborator

@jbouder jbouder commented Sep 26, 2024

This update is intended to support the scenario where the app form may be embedded in another app and does not need to display any top nav or side bar. This implementation will toggle and apply styling based on the following querystring parameter: headless=true

Reference Issues or PRs

Supports #472

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Screenshots

Screenshot 2024-09-26 at 2 59 49 PM

Any other comments?

  • Provides headless functionality through the use of a headless=true query param
  • Tracks headless state using global state
  • Hides top nav and side bar based on param
  • Hides Back buttons based on param

…when querystring contains headless equal to true. Update styling based on headless value.
Copy link

vercel bot commented Sep 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jhub-apps ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 1:49pm
jhub-apps-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 1:49pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant