Document JupyterLite Notebook custom widget #296
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
paulfitz
reviewed
Jan 4, 2024
help/widget-custom.md
Outdated
| - `async fetch_selected_table()`: returns the data of the table backing the notebook widget. | ||
| - `async fetch_selected_record(row_id=None)`: returns a record of the table backing the notebook widget. If `row_id` is specified, returns the record at that row. Otherwise, returns the record at the current cursor position in a widget linked to the notebook widget. | ||
| - `async fetch_table(table_id)`: returns the data of the specified table. Note that this differs from `fetch_selected_table` (even for the same table) in several ways: | ||
| - The widget must have full document access. |
There was a problem hiding this comment.
Whatever mkdocs is using for markdown isn't catching the nesting here, the list is staying flat -can you fiddle with spacing or switch to an alternate bullet marker or whatever it needs?
There was a problem hiding this comment.
good catch, fixed
help/widget-custom.md
Outdated
| - `async fetch_selected_record(row_id=None)`: returns a record of the table backing the notebook widget. If `row_id` is specified, returns the record at that row. Otherwise, returns the record at the current cursor position in a widget linked to the notebook widget. | ||
| - `async fetch_table(table_id)`: returns the data of the specified table. Note that this differs from `fetch_selected_table` (even for the same table) in several ways: | ||
| - The widget must have full document access. | ||
| - All columns are included, whereas `fetch_selected_table` excludes columns that are hidden in the widget configuration. |
There was a problem hiding this comment.
Is there an assumption of full access level here? Wondering if this should be explicitly mentioned.
There was a problem hiding this comment.
It's mentioned in the line above. Also this is just how fetch_table is, this has nothing to do with my plugin API changes for including more columns.
fflorent
pushed a commit
to fflorent/grist-help
that referenced
this pull request
Feb 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to #294, this mostly just moves the contents of https://github.com/gristlabs/jupyterlite-widget/blob/main/USAGE.md.