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

docs: add description for nav_js blocks #472

Merged
merged 1 commit into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/extras/bulma.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The `bulma_nav.*` templates produce the same output, and can be used as an easie

==- `pagy_bulma_nav_js(pagy, ...)`

See the [Javascript Navs](/docs/api/javascript/navs.md) documentation.
Looks exactly like `pagy_bulma_nav`, except it's rendered on the client, with optional responsiveness. See the [Javascript Navs](/docs/api/javascript/navs.md) documentation for more information.

=== `pagy_bulma_combo_nav_js(pagy, ...)`

Expand Down
2 changes: 1 addition & 1 deletion docs/extras/foundation.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The `foundation_nav.*` templates produce the same output, and can be used as an

==- `pagy_foundation_nav_js(pagy, ...)`

See the [Javascript Navs](/docs/api/javascript/navs.md) documentation.
Looks exactly like `pagy_foundation_nav`, except it's rendered on the client, with optional responsiveness. See the [Javascript Navs](/docs/api/javascript/navs.md) documentation for more information.

=== `pagy_foundation_combo_nav_js(pagy, ...)`

Expand Down
8 changes: 1 addition & 7 deletions docs/extras/materialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,7 @@ See the [pagy_nav(pagy, ...)](/docs/api/frontend.md#pagy-nav-pagy) documentation

==- `pagy_materialize_nav_js(pagy, ...)`

<!---
To do: Add a proper responsive image for semantic, as we have done for bootstrap.

![materialize_nav_js](/docs/assets/images/materialize_nav_js.png)
-->

See the [Javascript Navs](/docs/api/javascript/navs.md) documentation.
Looks exactly like `pagy_materialize_nav`, except it's rendered on the client, with optional responsiveness. See the [Javascript Navs](/docs/api/javascript/navs.md) documentation for more information.

=== `pagy_materialize_combo_nav_js(pagy, ...)`

Expand Down
8 changes: 1 addition & 7 deletions docs/extras/semantic.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,7 @@ See: [pagy_nav(pagy, ...)](/docs/api/frontend.md#pagy-nav-pagy).

==- `pagy_semantic_nav_js(pagy, ...)`

<!---
To do: Add a proper responsive image for semantic, as we have done for bootstrap.

![semantic_nav_js - Responsive nav.](/docs/assets/images/semantic_nav.png)
-->

See: [Javascript Navs](/docs/api/javascript/navs.md).
Looks exactly like `pagy_semantic_nav`, except it's rendered on the client, with optional responsiveness. See the [Javascript Navs](/docs/api/javascript/navs.md) documentation for more information.

=== `pagy_semantic_combo_nav_js(pagy, ...)`

Expand Down
2 changes: 1 addition & 1 deletion docs/extras/tailwind.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Tailwind allows to apply styles to any DOM element, so you don't actually need a

## Synopsis

See the [navs](navs.md) extra if you use `pagy_nav_js` or `pagy_combo_nav_js`.
See the [navs](navs.md) extra if you use `pagy_nav_js` (looks like pagy_nav, except it's rendered on the client, with optional responsiveness) or `pagy_combo_nav_js`.

Some sample styles you can copy / customize:

Expand Down
2 changes: 1 addition & 1 deletion docs/extras/uikit.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The `uikit_nav.*` templates produce the same output, and can be used as an easie

==- `pagy_uikit_nav_js(pagy, ...)`

See the [Javascript Navs](/docs/api/javascript/navs.md) documentation
Looks exactly like `pagy_uikit_nav`, except it's rendered on the client, with optional responsiveness. See the [Javascript Navs](/docs/api/javascript/navs.md) documentation for more information.

=== `pagy_uikit_combo_nav_js(pagy, ...)`

Expand Down