-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
[UI v2] feat: Loads data and url state to concurrency limit route for UX to consume #16227
Merged
devinvillarosa
merged 1 commit into
main
from
add-loaders-and-data-to-concurrency-limit-route
Dec 6, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,34 +1,81 @@ | ||
import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs"; | ||
import { TAB_OPTIONS, TabOptions } from "./concurrency-constants"; | ||
import { TabOptions } from "@/routes/concurrency-limits"; | ||
import { getRouteApi } from "@tanstack/react-router"; | ||
|
||
const routeApi = getRouteApi("/concurrency-limits"); | ||
|
||
type TabOptionValues = { | ||
/** Value of search value in url */ | ||
tabSearchValue: TabOptions; | ||
/** Display value for the UI */ | ||
displayValue: string; | ||
}; | ||
|
||
/** Maps url tab option to visual name */ | ||
const TAB_OPTIONS: Record<TabOptions, TabOptionValues> = { | ||
global: { | ||
tabSearchValue: "global", | ||
displayValue: "Global", | ||
}, | ||
["task-run"]: { | ||
tabSearchValue: "task-run", | ||
displayValue: "Task Run", | ||
}, | ||
} as const; | ||
|
||
type Props = { | ||
globalView: React.ReactNode; | ||
onValueChange: (value: TabOptions) => void; | ||
taskRunView: React.ReactNode; | ||
value: TabOptions; | ||
}; | ||
|
||
// TODO: Move Tabs for navigation to a generic styled component | ||
|
||
export const ConcurrencyTabs = ({ | ||
globalView, | ||
onValueChange, | ||
taskRunView, | ||
value, | ||
}: Props): JSX.Element => { | ||
const { tab } = routeApi.useSearch(); | ||
const navigate = routeApi.useNavigate(); | ||
|
||
return ( | ||
<Tabs | ||
defaultValue="Global" | ||
className="w-[400px]" | ||
value={value} | ||
onValueChange={(value) => onValueChange(value as TabOptions)} | ||
> | ||
<Tabs defaultValue="Global" value={tab}> | ||
<TabsList className="grid w-full grid-cols-2"> | ||
<TabsTrigger value="Global">{TAB_OPTIONS.Global}</TabsTrigger> | ||
<TabsTrigger value="Task Run">{TAB_OPTIONS["Task Run"]}</TabsTrigger> | ||
<TabsTrigger | ||
value={TAB_OPTIONS.global.tabSearchValue} | ||
onClick={() => { | ||
void navigate({ | ||
to: "/concurrency-limits", | ||
search: (prev) => ({ | ||
...prev, | ||
tab: TAB_OPTIONS.global.tabSearchValue, | ||
}), | ||
}); | ||
}} | ||
> | ||
{TAB_OPTIONS.global.displayValue} | ||
</TabsTrigger> | ||
|
||
<TabsTrigger | ||
value={TAB_OPTIONS["task-run"].tabSearchValue} | ||
onClick={() => { | ||
void navigate({ | ||
to: "/concurrency-limits", | ||
search: (prev) => ({ | ||
...prev, | ||
tab: TAB_OPTIONS["task-run"].tabSearchValue, | ||
}), | ||
}); | ||
}} | ||
> | ||
{TAB_OPTIONS["task-run"].displayValue} | ||
</TabsTrigger> | ||
</TabsList> | ||
<TabsContent value={TAB_OPTIONS.Global}>{globalView}</TabsContent> | ||
<TabsContent value={TAB_OPTIONS["Task Run"]}>{taskRunView}</TabsContent> | ||
<TabsContent value={TAB_OPTIONS.global.tabSearchValue}> | ||
{globalView} | ||
</TabsContent> | ||
<TabsContent value={TAB_OPTIONS["task-run"].tabSearchValue}> | ||
{taskRunView} | ||
</TabsContent> | ||
</Tabs> | ||
); | ||
}; |
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,11 +1,24 @@ | ||
import { ConcurrencyPage } from "@/components/concurrency/concurrency-page"; | ||
import { useListGlobalConcurrencyLimits } from "@/hooks/global-concurrency-limits"; | ||
import { createFileRoute } from "@tanstack/react-router"; | ||
import { zodSearchValidator } from "@tanstack/router-zod-adapter"; | ||
import { z } from "zod"; | ||
|
||
import { ConcurrencyPage } from "@/components/concurrency/concurrency-page"; | ||
/** | ||
* Schema for validating URL search parameters for the Concurrency Limits page. | ||
* @property {'global' | 'task-run'} tab used designate which tab view to display | ||
*/ | ||
const searchParams = z | ||
.object({ | ||
tab: z.enum(["global", "task-run"]).default("global"), | ||
}) | ||
.strict(); | ||
|
||
export type TabOptions = z.infer<typeof searchParams>["tab"]; | ||
|
||
export const Route = createFileRoute("/concurrency-limits")({ | ||
component: RouteComponent, | ||
validateSearch: zodSearchValidator(searchParams), | ||
component: ConcurrencyPage, | ||
wrapInSuspense: true, | ||
loader: useListGlobalConcurrencyLimits.loader, | ||
}); | ||
|
||
function RouteComponent() { | ||
return <ConcurrencyPage />; | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ended up using this
.loader
style for consistency withVariable
.But one principal I'm trying to keep in mind is
I think only exposing
queryOptions
andmutations
exposed to the webapp gives this flexibility because you can feed it into different loaders,useQuery
,useQueries
,useSuspenseQuery
, anduseSuspenseQueries
for different scenarios.But let keep building more stuff to see some similar patterns
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could end up with multiple entry points. In most cases, you can use the prebuilt hooks (a la
useVariables
), but developers can import and use the query options factory in cases where more customization is needed.