Pagination / Search Dialog#216
Merged
Merged
Conversation
…and query support
Contributor
|
This PR contains changes that modified the public API. To update the reference ABI dumps: ./gradlew updateLegacyAbi
git add **/api/**
git commit -m "Update ABI reference"
git pushAfter updating, the CI will pass. Make sure the changes are backward compatible. |
1 similar comment
Contributor
|
This PR contains changes that modified the public API. To update the reference ABI dumps: ./gradlew updateLegacyAbi
git add **/api/**
git commit -m "Update ABI reference"
git pushAfter updating, the CI will pass. Make sure the changes are backward compatible. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a composable dialog system to the Bukkit API module, with stateful rendering and a reusable paginated/searchable dialog helper, plus a plugin-test command demonstrating the new pagination UI.
Changes:
- Introduces dialog composition primitives (
DialogStore,DialogScope,composableDialog) to render dialogs from state and update/re-render on state changes. - Adds pagination/query abstractions (
DialogQuery,PageState,PageResult, etc.) and apaginatedDialogcomposable supporting optional search. - Adds a plugin-test command and sample dataset/query to demo paginated + searchable dialogs.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| surf-api-bukkit/surf-api-bukkit-plugin-test/src/main/kotlin/dev/slne/surf/surfapi/bukkit/test/command/subcommands/PaginatedDialogTest.kt | Adds a demo command, sample dataset, and a DialogQuery implementation for paginated/search filtering. |
| surf-api-bukkit/surf-api-bukkit-plugin-test/src/main/kotlin/dev/slne/surf/surfapi/bukkit/test/BukkitPluginMain.kt | Hooks the pagination dialog test command into the test plugin lifecycle. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/state/DialogState.kt | Adds a marker interface for dialog state types. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/query/states.kt | Defines paging/cursor state models used by dialog queries. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/query/results.kt | Defines page/cursor result models returned by queries. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/query/queries.kt | Adds query fun-interfaces for page/cursor data retrieval. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/pagination/PaginatedDialog.kt | Implements the reusable paginated/searchable dialog composable. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/composition/dsl.kt | Adds the composableDialog entrypoint DSL. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/composition/DialogStore.kt | Implements state storage, caching, and rerendering logic. |
| surf-api-bukkit/surf-api-bukkit-api/src/main/kotlin/dev/slne/surf/surfapi/bukkit/api/dialog/composition/DialogScope.kt | Exposes state helpers (state, setState, remember) for dialog rendering. |
Contributor
|
This PR contains changes that modified the public API. To update the reference ABI dumps: ./gradlew updateLegacyAbi
git add **/api/**
git commit -m "Update ABI reference"
git pushAfter updating, the CI will pass. Make sure the changes are backward compatible. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…default-dialogs # Conflicts: # surf-api-bukkit/surf-api-bukkit-plugin-test/src/main/kotlin/dev/slne/surf/surfapi/bukkit/test/command/dialog/subcommands/PaginatedDialogTest.kt
Contributor
|
This PR contains changes that modified the public API. To update the reference ABI dumps: ./gradlew updateLegacyAbi
git add **/api/**
git commit -m "Update ABI reference"
git pushAfter updating, the CI will pass. Make sure the changes are backward compatible. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new composable dialog architecture for Bukkit plugins, enabling stateful, paginated, and searchable dialogs for players. It includes a general-purpose dialog composition system, pagination support, dialog state/query abstractions, and a test command to demonstrate paginated dialogs in action.
Composable Dialog Architecture:
DialogScope,DialogStore, and acomposableDialogDSL to manage dialog state, state updates, and caching within a coroutine scope, allowing for reactive dialog UIs. [1] [2] [3]Pagination and Query Abstractions:
paginatedDialog, a reusable function for creating paginated and optionally searchable dialogs, supporting item rendering, pagination controls, and search reset.DialogQuery,CursorDialogQuery) and result/state data classes (PageResult,CursorResult,PageState,CursorState) to abstract data retrieval and pagination logic. [1] [2] [3]Dialog State Management:
DialogStatefor dialog state types, enabling type-safe state handling across the dialog system.Testing and Demonstration:
paginationDialogTestCommand) and supporting classes to showcase the paginated dialog system, including search functionality and navigation through a large dataset. Registered the command in the test plugin's main class. [1] [2] [3]