-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
106 changed files
with
1,657 additions
and
761 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
module: "@wq/material" | ||
purpose: lists | ||
--- | ||
|
||
# Accordion | ||
|
||
[@wq/material]'s `<Accordion/>` [component][index] implements expansion panels / accordions. `<Accordion/>` supports `summary`, `children`, `open` and `onOpen` props, converting as needed for web and native libaries. `<Accordion/>` is analogous to `<details>` in HTML. | ||
|
||
> This component was named `ExpansionPanel` in earlier versions of wq. | ||
## Source | ||
|
||
While [@wq/react] defines a [placeholder implementation][react-src], [@wq/material]'s versions are more useful as reference: | ||
|
||
* [Accordion.js (@wq/material-web)][material-web-src] | ||
* [Accordion.js (@wq/material-native)][material-native-src] | ||
|
||
|
||
[index]: ./index.md | ||
[@wq/react]: ../@wq/react.md | ||
[@wq/material]: ../@wq/material.md | ||
[react-src]: https://github.com/wq/wq.app/blob/main/packages/react/src/components/Accordion.js | ||
[material-web-src]: https://github.com/wq/wq.app/blob/main/packages/material-web/src/components/Accordion.js | ||
[material-native-src]: https://github.com/wq/wq.app/blob/main/packages/material-native/src/components/Accordion.js |
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
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
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,21 @@ | ||
--- | ||
module: "@wq/map-gl" | ||
module: "@wq/map" | ||
purpose: maps | ||
--- | ||
|
||
# BasemapToggle | ||
|
||
wq's `<BasemapToggle/>` [component] wraps [`<AutoBasemap/>`][AutoBasemap] with a radio switch that controls active state. | ||
[@wq/map]'s `<BasemapToggle/>` [component][index] wraps [`<AutoBasemap/>`][AutoBasemap] with a radio switch that controls active state. | ||
|
||
## Source | ||
|
||
While [@wq/map] defines a [placeholder implementation][map-src], [@wq/map-gl] and [@wq/leaflet]'s versions are more useful as reference: | ||
The source code for `<BasemapToggle/>` is available here: | ||
|
||
* [AutoBasemap.js (@wq/map-gl)][mapgl-src] | ||
* [Legend.js (@wq/leaflet)][leaflet-src] | ||
* [BasemapToggle.js (@wq/map)][map-src] | ||
|
||
[component]: ./index.md | ||
[AutoBasemap]: ./AutoBasemap.md | ||
[@wq/map]: ../@wq/map.md | ||
[@wq/map-gl]: ../@wq/map-gl.md | ||
[@wq/leaflet]: https://github.com/wq/wq.app/tree/v1.3.0/packages/leaflet | ||
This component should not generally need to be overridden directly. | ||
|
||
[map-src]: https://github.com/wq/wq.app/blob/main/packages/map/src/components/Legend.js | ||
[mapgl-src]: https://github.com/wq/wq.app/blob/main/packages/map-gl/src/components/BasemapToggle.js | ||
[leaflet-src]: https://github.com/wq/wq.app/blob/v1.3.0/packages/leaflet/src/components/Legend.js | ||
[index]: ./index.md | ||
[@wq/map]: ../@wq/map.md | ||
[AutoBasemap]: ./AutoBasemap.md | ||
[map-src]: https://github.com/wq/wq.app/blob/main/packages/map/src/components/BasemapToggle.js |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
module: "@wq/material" | ||
purpose: navigation | ||
--- | ||
|
||
# BottomNavigation | ||
|
||
[@wq/material]'s `<BottomNavigation/>` [component][index] can be used to add a persistent navbar with 2-5 icons to the bottom of the screen. | ||
|
||
## Source | ||
|
||
While [@wq/react] defines a [placeholder implementation][react-src], [@wq/material]'s versions are more useful as reference: | ||
|
||
* [BottomNavigation.js (@wq/material-web)][material-web-src] | ||
* [BottomNavigation.js (@wq/material-native)][material-native-src] | ||
|
||
> The @wq/material-web implementation just exports BottomNavigation from @mui/material. | ||
> The @wq/material-native implementation is currently just a placeholder. | ||
[index]: ./index.md | ||
[@wq/react]: ../@wq/react.md | ||
[@wq/material]: ../@wq/material.md | ||
[react-src]: https://github.com/wq/wq.app/blob/main/packages/react/src/components/BottomNavigation.js | ||
[material-web-src]: https://github.com/wq/wq.app/blob/main/packages/material-web/src/components/BottomNavigation.js | ||
[material-native-src]: https://github.com/wq/wq.app/blob/main/packages/material-native/src/components/BottomNavigation.js |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
module: "@wq/material" | ||
purpose: navigation | ||
--- | ||
|
||
# BottomNavigationAction | ||
|
||
[@wq/material]'s `<BottomNavigationAction/>` [component][index] is used to specify an individual tab and icon for [BottomNavigation]. | ||
|
||
## Source | ||
|
||
While [@wq/react] defines a [placeholder implementation][react-src], [@wq/material]'s versions are more useful as reference: | ||
|
||
* [BottomNavigationAction.js (@wq/material-web)][material-web-src] | ||
* [BottomNavigationAction.js (@wq/material-native)][material-native-src] | ||
|
||
> The @wq/material-native implementation is currently just a placeholder. | ||
[index]: ./index.md | ||
[@wq/react]: ../@wq/react.md | ||
[@wq/material]: ../@wq/material.md | ||
[BottomNavigation]: ./BottomNavigation.md | ||
[react-src]: https://github.com/wq/wq.app/blob/main/packages/react/src/components/BottomNavigationAction.js | ||
[material-web-src]: https://github.com/wq/wq.app/blob/main/packages/material-web/src/components/BottomNavigationAction.js | ||
[material-native-src]: https://github.com/wq/wq.app/blob/main/packages/material-native/src/components/BottomNavigationAction.js |
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
Oops, something went wrong.