-
Notifications
You must be signed in to change notification settings - Fork 2.2k
website: Update whatsnew #9784
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
base: master
Are you sure you want to change the base?
website: Update whatsnew #9784
Conversation
docs/whats-new.md
Outdated
### Widgets | ||
|
||
- A suite of new widgets have been added to the [`@deck.gl/widgets`](./api-reference/widgets/overview.md) module: | ||
- ContextMenuWidget |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Some of these are less mature / more experimental and it was kind of semi-intentional that they were omitted here.
- It might be worth going through widgets/index.ts and review what should be exported with underscore and what should not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, so for the whatsnew, should we remove the 4 that don't have any docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As for marking experimental/exporting with underscore - I feel the widgets are all pretty self-contained, so there is not so much harm done removing the underscore, we save users from a future breaking change that way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is not so much harm done removing the underscore, we save users from a future breaking change that way.
OK sure. This is how I thought about it:
- To me, the underscore signals that these are not fully audited and ready, and may change.
- a downside if we remove the underscore and then change the widget props is that we may break user code with less warning...
Generally we have a higher bar for experimental code in deck.gl, but since widgets is a new area I felt it was OK to be more experimental.
My alternative was to put the underscore widgets in @deck.gl-community/widgets
, while that would keep deck widgets to a higher bar, it would also slow down experimentation and adoption a little.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be relatively little effort to add the 4 missing docs.
The thinking too is we can make breaking changes to props in a minor release on experimental components, or even remove/combine/split-apart widgets.
I'd prefer to keep the underscore, or just clearly denote they're experimental in some other way
|
||
### WebGPU Early Preview | ||
|
||
A few deck.gl layers can now be run on WebGPU in the website, by selecting the `WebGPU` tab. See documentation about how to [test WebGPU support](./developer-guide/webgpu.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we are going through the trouble of listing all widgets, should we also list webgpu ready layers?
And maybe add a WebGPU badge to their doc pages?
|
||
A suite of new widgets have been added to the [`@deck.gl/widgets`](./api-reference/widgets/overview.md) module: | ||
- [`View.clone()`](./api-reference/core/view.md) - New method that simplifies creating new Views with modified props, similar to `Layer.clone()` | ||
- Async DeckPicker methods - New asynchronous methods for improved picking performance and non-blocking operations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Async DeckPicker methods - New asynchronous methods for improved picking performance and non-blocking operations | |
- Async DeckPicker methods - New asynchronous methods for non-blocking operations and (depending on platform and usage) improved picking performance. |
For #9172, preview the changes here: https://felixpalmer.github.io/deck.gl/docs/whats-new
I've done a review of what new features are in
master
in the codebase & the docs. I've cross-referenced who is responsible for each change, could you check you're happy with the added text:@ibgreen-openai widgets, core async picker, View.clone, WebGPU layers
@chrisgervang Multi-view support, widget theming, pydeck integration
There are a few docs pages missing still, these can be added in follow up PRs
Change List