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

allow bundled widgets to be hidden from dropdown, and nested #714

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

paulfitz
Copy link
Member

This makes a few refinements to bundling widgets:

  • A widget with published: false is not shown in the custom widget dropdown in the UI. This is so widgets can be bundled with the app for "native" use (like the calendar widget) without immediately resulting in an extra listing in the UI. (There are improvements we'd like to make to the UI to better communicate widget provenance and quality eventually, which would be a helpful alternative to just a binary flag.)

  • A relative path to the custom widget manifest is respected. This will make the bundling process marginally neater.

This makes a few refinements to bundling widgets:

  * A widget with `published: false` is not shown in the
    custom widget dropdown in the UI. This is so widgets
    can be bundled with the app for "native" use (like the
    calendar widget) without immediately resulting in an
    extra listing in the UI. (There are improvements we'd
    like to make to the UI to better communicate widget
    provenance and quality eventually, which would be a
    helpful alternative to just a binary flag.)

  * A relative path to the custom widget manifest is
    respected. This will make the bundling process marginally
    neater.
@paulfitz
Copy link
Member Author

paulfitz commented Oct 30, 2023

As a way to manually test: unpack this in the plugins directory:
grist-widget-bundle.zip
Then restart Grist as:
GRIST_WIDGET_LIST_URL="" yarn start
A document with a calendar widget should correctly display that widget with the bundle in place, and not without.

The bundle was built using the code at gristlabs/grist-widget#69 (and setting published: false in the output manually).

Copy link
Contributor

@georgegevoian georgegevoian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @paulfitz.

@paulfitz paulfitz merged commit 07bb90b into main Oct 31, 2023
13 checks passed
@paulfitz paulfitz deleted the paulfitz/bundling-tweaks branch October 31, 2023 01:13
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.

2 participants