feat(pagination): add navigation methods #9154

josercarcamo · 2024-04-18T23:22:38Z

Related Issue: #6344

Summary

Add methods to navigate to the first, last, and an arbitrary page.

…com:Esri/calcite-design-system into josercarcamo/6344-additional-nav-pagination

jcfranco · 2024-04-19T17:28:09Z

For consistency, can we use navigation vs seek in the PR title?

macandcheese · 2024-04-19T17:42:58Z

packages/calcite-components/src/components/pagination/pagination.tsx

+
+  /** Set the first page as active. */
+  @Method()
+  async startPage(): Promise<void> {


Should these be goToStartPage and goToEndPage to match goToPage ?

stepper.tsx has them as "goToStep", "startStep", and "endStep", but I'll change them if desired.

I know we don't have a ton of public methods in general so we could probably update those if needed for consistency (if we want to go that direction). cc @jcfranco (I know we had also mentioned removing the Stepper ones, so maybe that needs to be reconsidered as well).

Good discussion. We should definitely be consistent, but from an API-perspective, we should use verbs for methods and nouns for properties. I see the following options:

use the same name for consistency (following existing stepper ones)

consolidate these into a single method with the following signature:
goToPage(page: number | "start" |"end"): void;

We'd create a follow-up issue to revisit APIs for consistency regardless.

I'm kind of leaning towards 2 since it introduces a single method, it is named as a verb, it is concise, and is flexible.

Sidebar, I think we can close #6134. I don't see anything wrong with the convenience methods.

Do we really even need Page? The component is pagination. Seems kind of repetitive to have Page in there.

pagination.goTo("start") seems sufficient, no?

or pagination.page("start")??? Since the act of using the component is paging?

I do prefer a single method vs end(), start(), etc.

@jcfranco what should I do regarding the following:

What @driskull commented above

Should the method return something when the page requested is out of range? I was thinking "true" when successful and "false" if not?

Also, @macandcheese asked "what if the last / first item is already active and a goToPage call is made to the same item?"

Good idea. We can drop Page.

What's the use case? Alternatively, we can clamp to the closest if the requested page is beyond the range.

That'd be a noop, methinks.

For 2, it would be, for example, if there are only 10 pages but the caller requests page 12. Similarly, if somehow the user requests page 0.

Maybe it should throw an error or log a warning and clamp the value to its limits?

…dded tests

…com:Esri/calcite-design-system into josercarcamo/6344-additional-nav-pagination

josercarcamo · 2024-04-24T02:32:36Z

@driskull @jcfranco @macandcheese one more review please.

driskull

🌞 Awesome! 👏

driskull · 2024-04-24T16:07:53Z

@josercarcamo since this PR doesn't affect styles, we can add the label "skip visual snapshots" and the screener tests won't be required.

jcfranco

🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢
🔢📄📄📄📄🔢📄🔢🔢🔢🔢🔢📄🔢📄📄📄📄🔢🔢📄📄📄🔢🔢📄📄🔢🔢📄🔢🔢🔢📄🔢📄📄📄📄🔢📄🔢
🔢📄🔢🔢📄🔢📄🔢🔢🔢🔢🔢📄🔢📄🔢🔢🔢🔢📄🔢🔢🔢🔢📄🔢🔢📄🔢📄📄🔢📄📄🔢📄🔢🔢🔢🔢📄🔢
🔢📄📄📄📄🔢📄🔢🔢📄🔢🔢📄🔢📄📄📄🔢🔢🔢📄📄🔢🔢📄🔢🔢📄🔢📄🔢📄🔢📄🔢📄📄📄🔢🔢📄🔢
🔢📄🔢🔢📄🔢📄🔢📄🔢📄🔢📄🔢📄🔢🔢🔢🔢🔢🔢🔢📄🔢📄🔢🔢📄🔢📄🔢🔢🔢📄🔢📄🔢🔢🔢🔢🔢🔢
🔢📄🔢🔢📄🔢🔢📄🔢🔢🔢📄🔢🔢📄📄📄📄🔢📄📄📄🔢🔢🔢📄📄🔢🔢📄🔢🔢🔢📄🔢📄📄📄📄🔢📄🔢
🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢🔢

@geospatialem @DitwanP for editorial glancing

geospatialem · 2024-04-24T17:58:31Z

@geospatialem @DitwanP for editorial glancing

The doc addition LGTM 👍🏻 and it is in alignment with other similar methods, such as stepper. 🚀

calcite-design-system/packages/calcite-components/src/components/stepper/stepper.tsx

Lines 294 to 296 in 6d269b3

    
             /** 
        
              * Set a specified `calcite-stepper-item` as active. 
        
              *

🤖 I have created a release *beep* *boop* --- <details><summary>@esri/calcite-design-tokens: 2.2.0</summary> ## [2.2.0](https://github.com/Esri/calcite-design-system/compare/@esri/[email protected]...@esri/[email protected]) (2024-04-30) ### Features * Ensure all components inherit font-family ([#8388](#8388)) ([90f8923](90f8923)) </details> <details><summary>@esri/eslint-plugin-calcite-components: 1.2.0</summary> ## [1.2.0](https://github.com/Esri/calcite-design-system/compare/@esri/[email protected]...@esri/[email protected]) (2024-04-30) ### Features * **enforce-ref-last-prop:** Add fixer ([#8671](#8671)) ([688bc51](688bc51)) ### Bug Fixes * **slider:** Improve snapping + step logic ([#8169](#8169)) ([8b83042](8b83042)) </details> <details><summary>@esri/calcite-components: 2.8.0</summary> ## [2.8.0](https://github.com/Esri/calcite-design-system/compare/@esri/[email protected]...@esri/[email protected]) (2024-04-30) ### Features * Add calciteInvalid event for form validation ([#9211](#9211)) ([a504508](a504508)) * Add validity property to form components ([#9210](#9210)) ([e49902b](e49902b)) * **carousel:** Add Carousel and Carousel Item components ([#8995](#8995)) ([b1ba428](b1ba428)) * **enforce-ref-last-prop:** Add fixer ([#8671](#8671)) ([688bc51](688bc51)) * Ensure all components inherit font-family ([#8388](#8388)) ([90f8923](90f8923)) * **input-time-zone:** Add readonly support ([#9111](#9111)) ([153a122](153a122)) * **input-time-zone:** Allow clearing value ([#9168](#9168)) ([193bb7d](193bb7d)) * **list-item-group:** Update list item group styles ([#9072](#9072)) ([c734849](c734849)) * **navigation-logo:** Add heading level ([#9054](#9054)) ([c2beba8](c2beba8)) * **pagination:** Add navigation methods ([#9154](#9154)) ([5ca6a5f](5ca6a5f)) * **slider:** Add support for custom label formatting ([#9179](#9179)) ([710d1ee](710d1ee)) * **slider:** Allow configuring fill behavior ([#9170](#9170)) ([1b2cdbf](1b2cdbf)) * **tile, tile-group:** Support single, multi, single-persist, none selection modes and icon and border selection appearances ([#9159](#9159)) ([2d77470](2d77470)) ### Bug Fixes * **action:** Maintain equal height when text is not enabled in a small scale ([#9051](#9051)) ([407824a](407824a)) * **chip-group:** Improve programmatic Chip selection behavior ([#9213](#9213)) ([b7a4c77](b7a4c77)) * **combobox:** Update the focus and hover chevron icon color ([#9187](#9187)) ([a1317da](a1317da)) * **combobox, input-time-zone:** Improve readOnly behavior and styling ([#9222](#9222)) ([606d80f](606d80f)) * **combobox:** Fix aria-role for proper voiceover support ([#9039](#9039)) ([eebe8ca](eebe8ca)) * **combobox:** Update the focused chevron icon color ([#9202](#9202)) ([27ac02d](27ac02d)) * **date-picker:** Ensure `proximitySelectionDisabled` resets range on post-range-commit selection ([#9171](#9171)) ([f466b14](f466b14)) * **date-picker:** Restore focus on date when navigating month with arrow/page keys ([#9063](#9063)) ([db109e0](db109e0)) * Fix memory leak affecting components using conditionally-rendered slots ([#9208](#9208)) ([28701b6](28701b6)) * **input-date-picker:** Update the focus and hover chevron icon color ([#9146](#9146)) ([ca895e9](ca895e9)) * **input-time-zone:** Ensure selected item is properly displayed when there are other items with the same offset ([#9134](#9134)) ([1f94903](1f94903)) * **input, input-number, input-text, input-date-picker, input-time-picker, filter, menu-item:** Ignore canceled events and enforce cancellations where needed ([#8952](#8952)) ([d0fa977](d0fa977)) * **list, list-item, list-item-group:** Improve drag experience by indenting items ([#9169](#9169)) ([88aab49](88aab49)) * **list, list-item:** Support keyboard sorting in screen readers ([#9038](#9038)) ([b2e1b9b](b2e1b9b)) * **list:** Closed list-items no longer render extra space ([#9031](#9031)) ([3985004](3985004)) * **panel:** Support cancelling the esc key event to prevent closing a panel ([#9032](#9032)) ([ecfa5f1](ecfa5f1)) * **preset:** Update the focus outline color ([#9098](#9098)) ([725f47c](725f47c)) * **radio-button:** Display validation message in parent group ([#9218](#9218)) ([b1e869f](b1e869f)) * **select:** Update the focus and hover chevron icon color and select focus and hover background color ([#9160](#9160)) ([b187340](b187340)) * **slider:** Fix fill placement and tick styling when ranged ([#9204](#9204)) ([a84d831](a84d831)) * **slider:** Improve snapping + step logic ([#8169](#8169)) ([8b83042](8b83042)) * **slider:** Rename `highlightPlacement` to `fillPlacement` ([#9195](#9195)) ([9e5a713](9e5a713)) * **slider:** Style ticks according to the fill placement ([#9196](#9196)) ([5eb4e10](5eb4e10)) * **stepper-item:** Remove delay in highlighting item ([#8996](#8996)) ([bcf23dd](bcf23dd)) * **tree-item:** Do not select when chevron clicked ([#9115](#9115)) ([99ad8f1](99ad8f1)) ### Dependencies * The following workspace dependencies were updated * devDependencies * @esri/calcite-design-tokens bumped from ^2.2.0-next.0 to ^2.2.0 * @esri/eslint-plugin-calcite-components bumped from ^1.2.0-next.1 to ^1.2.0 </details> <details><summary>@esri/calcite-components-angular: 2.8.0</summary> ## [2.8.0](https://github.com/Esri/calcite-design-system/compare/@esri/[email protected]...@esri/[email protected]) (2024-04-30) ### Miscellaneous Chores * **@esri/calcite-components-angular:** Synchronize components versions ### Dependencies * The following workspace dependencies were updated * dependencies * @esri/calcite-components bumped from ^2.8.0-next.20 to ^2.8.0 </details> <details><summary>@esri/calcite-components-react: 2.8.0</summary> ## [2.8.0](https://github.com/Esri/calcite-design-system/compare/@esri/[email protected]...@esri/[email protected]) (2024-04-30) ### Miscellaneous Chores * **@esri/calcite-components-react:** Synchronize components versions ### Dependencies * The following workspace dependencies were updated * dependencies * @esri/calcite-components bumped from ^2.8.0-next.20 to ^2.8.0 </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

feat(pagination): add seek methods

e71dded

josercarcamo requested a review from a team as a code owner April 18, 2024 23:22

Merge branch 'main' into josercarcamo/6344-additional-nav-pagination

42d5fb9

github-actions bot assigned josercarcamo Apr 18, 2024

github-actions bot added the enhancement Issues tied to a new feature or request. label Apr 18, 2024

josercarcamo added 2 commits April 19, 2024 10:18

feat(pagination): add seek methods

9b1a1ce

Merge branch 'josercarcamo/6344-additional-nav-pagination' of github.…

24b9d0c

…com:Esri/calcite-design-system into josercarcamo/6344-additional-nav-pagination

josercarcamo added 2 commits April 19, 2024 10:39

feat(pagination): add seek methods

5a91183

feat(pagination): add seek methods

3d59134

josercarcamo changed the title ~~feat(pagination): add seek methods~~ feat(pagination): add navigation methods Apr 19, 2024

feat(pagination): add seek methods

f35815d

macandcheese reviewed Apr 19, 2024

View reviewed changes

josercarcamo and others added 6 commits April 19, 2024 12:44

feat(pagination): Refactored code per code review

6e92bb9

feat(pagination): renamed method, handled out-of-bounds values, and a…

223b2e5

…dded tests

Merge branch 'main' into josercarcamo/6344-additional-nav-pagination

aef911f

Removed unused method prototypes

99274db

Merge branch 'josercarcamo/6344-additional-nav-pagination' of github.…

ed7c22e

…com:Esri/calcite-design-system into josercarcamo/6344-additional-nav-pagination

Removed unused method prototypes

cb2b7e0

driskull approved these changes Apr 24, 2024

View reviewed changes

jcfranco approved these changes Apr 24, 2024

View reviewed changes

Merge branch 'main' into josercarcamo/6344-additional-nav-pagination

3dd7cef

josercarcamo added the skip visual snapshots Pull requests that do not need visual regression testing. label Apr 24, 2024

josercarcamo merged commit 5ca6a5f into main Apr 24, 2024
14 checks passed

josercarcamo deleted the josercarcamo/6344-additional-nav-pagination branch April 24, 2024 20:10

github-actions bot added this to the 2024-04-30 - Apr Release milestone Apr 24, 2024

calcite-admin mentioned this pull request Apr 24, 2024

chore: release main #9050

Merged

calcite-admin mentioned this pull request May 14, 2024

chore: release main #9237

Merged

calcite-admin mentioned this pull request May 28, 2024

chore: release hotfix #9438

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(pagination): add navigation methods #9154

feat(pagination): add navigation methods #9154

josercarcamo commented Apr 18, 2024

jcfranco commented Apr 19, 2024

macandcheese Apr 19, 2024

josercarcamo Apr 19, 2024

macandcheese Apr 19, 2024

jcfranco Apr 19, 2024

driskull Apr 22, 2024

driskull Apr 22, 2024

josercarcamo Apr 22, 2024 •

edited

Loading

jcfranco Apr 23, 2024

josercarcamo Apr 23, 2024

driskull Apr 23, 2024

josercarcamo commented Apr 24, 2024

driskull left a comment

driskull commented Apr 24, 2024

jcfranco left a comment

geospatialem commented Apr 24, 2024

feat(pagination): add navigation methods #9154

feat(pagination): add navigation methods #9154

Conversation

josercarcamo commented Apr 18, 2024

Summary

jcfranco commented Apr 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josercarcamo Apr 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josercarcamo commented Apr 24, 2024

driskull left a comment

Choose a reason for hiding this comment

driskull commented Apr 24, 2024

jcfranco left a comment

Choose a reason for hiding this comment

geospatialem commented Apr 24, 2024

josercarcamo Apr 22, 2024 •

edited

Loading