The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import { createContext, useContext } from "react";
import type { SdkDashboardId } from "embedding-sdk-bundle/types/dashboard";
import type { SdkEntityId } from "embedding-sdk-bundle/types/entity";
import type { NavigationId } from "embedding-sdk-bundle/types/navigation";
import type { SdkQuestionId } from "embedding-sdk-bundle/types/question";
import type { ParameterValues } from "metabase/embedding-sdk/types/dashboard";
import type { DashboardTabId, ParameterValueOrArray } from "metabase-types/api";
// This type exists only to have a global place where to put the JSDoc for virtual
type BaseEntry = {
/** "Virtual" entries are entries that are rendered by the previous entity and not by the SdkInternalNavigationProvider directly (ie: drills, new question from dashboard)
* We still need the entry object in the stack to keep track of them and make the back button work correctly
*/
virtual?: boolean;
};
export type SdkInternalNavigationEntry =
| (BaseEntry & {
type: "dashboard";
id: SdkDashboardId;
/** Set for click-behavior targets. */
entityId?: SdkEntityId;
name: string;
virtual?: true;
parameters?: ParameterValues;
/** Id-keyed parameter values used for same-dashboard merge dispatch. */
parameterIdValuePairs?: [string, ParameterValueOrArray | null][];
tabId?: DashboardTabId;
onPop?: () => void;
})
| (BaseEntry & {
type: "question";
id: SdkQuestionId | null;
/** Set for click-behavior targets. */
entityId?: SdkEntityId;
name: string;
virtual?: true;
parameters?: ParameterValues;
onPop?: () => void;
})
| (BaseEntry & {
/** A pre-filtered ad-hoc question, rendered from its serialized path. */
type: "ad-hoc-question";
name: string;
virtual?: true;
adHocQuestionPath: string;
onPop?: () => void;
})
| (BaseEntry & {
type: "metabase-browser";
virtual: false;
onPop?: () => void;
})
| (BaseEntry & {
/** Parent component handles rendering, this just tracks navigation depth */
type: "question-drill";
virtual: true;
name: string;
onPop?: () => void;
})
| (BaseEntry & {
/** Opening a card from dashboard (clicking card title or click behavior) */
type: "open-card";
virtual: true;
name: string;
onPop?: () => void;
})
| (BaseEntry & {
/** New question creation from dashboard */
type: "new-question";
virtual: true;
onPop?: () => void;
});
export type SdkInternalNavigationStackEntry = SdkInternalNavigationEntry & {
/** Random id of this visit, set when the entry is added to the stack. Key into `navigatedEntityParameters`. */
navigationId: NavigationId;
};
export type SdkInternalNavigationContextValue = {
stack: SdkInternalNavigationStackEntry[];
push: (entry: SdkInternalNavigationEntry) => void;
pop: () => void;
currentEntry: SdkInternalNavigationStackEntry | undefined;
canGoBack: boolean;
previousEntry: SdkInternalNavigationStackEntry | undefined;
initWithDashboard: (dashboard: { id: SdkDashboardId; name: string }) => void;
/**
* True when nav stack has pushed beyond the original entity. SdkDashboard reads
* this to skip its own styled wrapper so the outer wrapper from the provider
* stays the sole styled container (height/sticky/scroll behavior preserved).
*/
hasNavigatedToEntity: boolean;
};
export const SdkInternalNavigationContext =
createContext<SdkInternalNavigationContextValue | null>(null);
export const useSdkInternalNavigation =
(): SdkInternalNavigationContextValue => {
const ctx = useContext(SdkInternalNavigationContext);
if (!ctx) {
throw new Error(
"useSdkInternalNavigation must be used within SdkInternalNavigationProvider",
);
}
return ctx;
};
/**
* Optional version of useSdkInternalNavigation that returns null if outside provider.
* Useful for components that may be rendered outside the navigation context.
*/
export const useSdkInternalNavigationOptional = () => {
return useContext(SdkInternalNavigationContext);
};