visgl / deck.gl / 18044437842

91%

push

github

chore(widgets) audit props and docs (#9796)

* Add viewId prop to all widgets for multi-view support

Introduces a standardized `viewId` prop to all widget components, enabling them to attach to specific views when using multiple views. Updates defaultProps, constructors, and setProps methods to handle the new prop, and improves JSDoc comments for clarity. Also adds copyright headers to several files for consistency.

* Refactor widget exports and update overview documentation

Reorganized widget exports in index.ts into clearer categories: navigation, geospatial, view, information, control, and utility widgets. Updated the overview documentation to reflect the new structure and added missing widgets to the lists for improved clarity and discoverability.

* Refactor widget docs to centralize WidgetProps

Updated widget documentation to reference generic WidgetProps from core/widget.md, removing redundant prop listings from individual widget docs. This improves consistency and maintainability by centralizing prop definitions and reducing duplication.

* Add usage sections and version badges to widget docs

Updated documentation for multiple deck.gl widgets to include 'Usage' sections and version badges, improving clarity and consistency.

* Document default prop values for widget API

Updates API reference docs for all widgets to consistently document default values for props, improving clarity for users. Default values are now listed before descriptions for easier reference.

* Add usage section to TimelineWidget docs

* Add source links to widget API docs

* Audit widget docs for missing props

Added documentation for GimbalWidget, InfoWidget, ResetViewWidget, and ScreenshotWidget

* [fix] Invoke onViewModeChange callback on mode select

The ViewSelectorWidget now calls the onViewModeChange callback when the view mode is changed, enabling external handling of view mode changes. Updated documentation to reflect this behavior.

* Remove 'none' option f... (continued)

6796 of 7467 branches covered (91.01%)

Branch coverage included in aggregate %.

15 of 15 new or added lines in 1 file covered. (100.0%)

56170 of 61628 relevant lines covered (91.14%)

14311.12 hits per line