mirror of
https://ghproxy.net/https://github.com/abhijitb/helix.git
synced 2025-08-28 15:18:54 +08:00
Initial commit
This commit is contained in:
commit
153a4e9fd7
345 changed files with 359185 additions and 0 deletions
157
node_modules/react-router/dist/lib/components.d.ts
generated
vendored
Normal file
157
node_modules/react-router/dist/lib/components.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,157 @@
|
|||
import type { InitialEntry, LazyRouteFunction, Location, RelativeRoutingType, Router as RemixRouter, To, TrackedPromise } from "@remix-run/router";
|
||||
import { Action as NavigationType } from "@remix-run/router";
|
||||
import * as React from "react";
|
||||
import type { IndexRouteObject, Navigator, NonIndexRouteObject, RouteMatch, RouteObject } from "./context";
|
||||
export interface FutureConfig {
|
||||
v7_relativeSplatPath: boolean;
|
||||
v7_startTransition: boolean;
|
||||
}
|
||||
export interface RouterProviderProps {
|
||||
fallbackElement?: React.ReactNode;
|
||||
router: RemixRouter;
|
||||
future?: Partial<Pick<FutureConfig, "v7_startTransition">>;
|
||||
}
|
||||
/**
|
||||
* Given a Remix Router instance, render the appropriate UI
|
||||
*/
|
||||
export declare function RouterProvider({ fallbackElement, router, future, }: RouterProviderProps): React.ReactElement;
|
||||
export interface MemoryRouterProps {
|
||||
basename?: string;
|
||||
children?: React.ReactNode;
|
||||
initialEntries?: InitialEntry[];
|
||||
initialIndex?: number;
|
||||
future?: Partial<FutureConfig>;
|
||||
}
|
||||
/**
|
||||
* A `<Router>` that stores all entries in memory.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/router-components/memory-router
|
||||
*/
|
||||
export declare function MemoryRouter({ basename, children, initialEntries, initialIndex, future, }: MemoryRouterProps): React.ReactElement;
|
||||
export interface NavigateProps {
|
||||
to: To;
|
||||
replace?: boolean;
|
||||
state?: any;
|
||||
relative?: RelativeRoutingType;
|
||||
}
|
||||
/**
|
||||
* Changes the current location.
|
||||
*
|
||||
* Note: This API is mostly useful in React.Component subclasses that are not
|
||||
* able to use hooks. In functional components, we recommend you use the
|
||||
* `useNavigate` hook instead.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/components/navigate
|
||||
*/
|
||||
export declare function Navigate({ to, replace, state, relative, }: NavigateProps): null;
|
||||
export interface OutletProps {
|
||||
context?: unknown;
|
||||
}
|
||||
/**
|
||||
* Renders the child route's element, if there is one.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/components/outlet
|
||||
*/
|
||||
export declare function Outlet(props: OutletProps): React.ReactElement | null;
|
||||
export interface PathRouteProps {
|
||||
caseSensitive?: NonIndexRouteObject["caseSensitive"];
|
||||
path?: NonIndexRouteObject["path"];
|
||||
id?: NonIndexRouteObject["id"];
|
||||
lazy?: LazyRouteFunction<NonIndexRouteObject>;
|
||||
loader?: NonIndexRouteObject["loader"];
|
||||
action?: NonIndexRouteObject["action"];
|
||||
hasErrorBoundary?: NonIndexRouteObject["hasErrorBoundary"];
|
||||
shouldRevalidate?: NonIndexRouteObject["shouldRevalidate"];
|
||||
handle?: NonIndexRouteObject["handle"];
|
||||
index?: false;
|
||||
children?: React.ReactNode;
|
||||
element?: React.ReactNode | null;
|
||||
hydrateFallbackElement?: React.ReactNode | null;
|
||||
errorElement?: React.ReactNode | null;
|
||||
Component?: React.ComponentType | null;
|
||||
HydrateFallback?: React.ComponentType | null;
|
||||
ErrorBoundary?: React.ComponentType | null;
|
||||
}
|
||||
export interface LayoutRouteProps extends PathRouteProps {
|
||||
}
|
||||
export interface IndexRouteProps {
|
||||
caseSensitive?: IndexRouteObject["caseSensitive"];
|
||||
path?: IndexRouteObject["path"];
|
||||
id?: IndexRouteObject["id"];
|
||||
lazy?: LazyRouteFunction<IndexRouteObject>;
|
||||
loader?: IndexRouteObject["loader"];
|
||||
action?: IndexRouteObject["action"];
|
||||
hasErrorBoundary?: IndexRouteObject["hasErrorBoundary"];
|
||||
shouldRevalidate?: IndexRouteObject["shouldRevalidate"];
|
||||
handle?: IndexRouteObject["handle"];
|
||||
index: true;
|
||||
children?: undefined;
|
||||
element?: React.ReactNode | null;
|
||||
hydrateFallbackElement?: React.ReactNode | null;
|
||||
errorElement?: React.ReactNode | null;
|
||||
Component?: React.ComponentType | null;
|
||||
HydrateFallback?: React.ComponentType | null;
|
||||
ErrorBoundary?: React.ComponentType | null;
|
||||
}
|
||||
export type RouteProps = PathRouteProps | LayoutRouteProps | IndexRouteProps;
|
||||
/**
|
||||
* Declares an element that should be rendered at a certain URL path.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/components/route
|
||||
*/
|
||||
export declare function Route(_props: RouteProps): React.ReactElement | null;
|
||||
export interface RouterProps {
|
||||
basename?: string;
|
||||
children?: React.ReactNode;
|
||||
location: Partial<Location> | string;
|
||||
navigationType?: NavigationType;
|
||||
navigator: Navigator;
|
||||
static?: boolean;
|
||||
future?: Partial<Pick<FutureConfig, "v7_relativeSplatPath">>;
|
||||
}
|
||||
/**
|
||||
* Provides location context for the rest of the app.
|
||||
*
|
||||
* Note: You usually won't render a `<Router>` directly. Instead, you'll render a
|
||||
* router that is more specific to your environment such as a `<BrowserRouter>`
|
||||
* in web browsers or a `<StaticRouter>` for server rendering.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/router-components/router
|
||||
*/
|
||||
export declare function Router({ basename: basenameProp, children, location: locationProp, navigationType, navigator, static: staticProp, future, }: RouterProps): React.ReactElement | null;
|
||||
export interface RoutesProps {
|
||||
children?: React.ReactNode;
|
||||
location?: Partial<Location> | string;
|
||||
}
|
||||
/**
|
||||
* A container for a nested tree of `<Route>` elements that renders the branch
|
||||
* that best matches the current location.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/components/routes
|
||||
*/
|
||||
export declare function Routes({ children, location, }: RoutesProps): React.ReactElement | null;
|
||||
export interface AwaitResolveRenderFunction {
|
||||
(data: Awaited<any>): React.ReactNode;
|
||||
}
|
||||
export interface AwaitProps {
|
||||
children: React.ReactNode | AwaitResolveRenderFunction;
|
||||
errorElement?: React.ReactNode;
|
||||
resolve: TrackedPromise | any;
|
||||
}
|
||||
/**
|
||||
* Component to use for rendering lazily loaded data from returning defer()
|
||||
* in a loader function
|
||||
*/
|
||||
export declare function Await({ children, errorElement, resolve }: AwaitProps): React.JSX.Element;
|
||||
/**
|
||||
* Creates a route config from a React "children" object, which is usually
|
||||
* either a `<Route>` element or an array of them. Used internally by
|
||||
* `<Routes>` to create a route config from its children.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/utils/create-routes-from-children
|
||||
*/
|
||||
export declare function createRoutesFromChildren(children: React.ReactNode, parentPath?: number[]): RouteObject[];
|
||||
/**
|
||||
* Renders the result of `matchRoutes()` into a React element.
|
||||
*/
|
||||
export declare function renderMatches(matches: RouteMatch[] | null): React.ReactElement | null;
|
102
node_modules/react-router/dist/lib/context.d.ts
generated
vendored
Normal file
102
node_modules/react-router/dist/lib/context.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,102 @@
|
|||
import * as React from "react";
|
||||
import type { AgnosticIndexRouteObject, AgnosticNonIndexRouteObject, AgnosticRouteMatch, History, LazyRouteFunction, Location, Action as NavigationType, RelativeRoutingType, Router, StaticHandlerContext, To, TrackedPromise } from "@remix-run/router";
|
||||
export interface IndexRouteObject {
|
||||
caseSensitive?: AgnosticIndexRouteObject["caseSensitive"];
|
||||
path?: AgnosticIndexRouteObject["path"];
|
||||
id?: AgnosticIndexRouteObject["id"];
|
||||
loader?: AgnosticIndexRouteObject["loader"];
|
||||
action?: AgnosticIndexRouteObject["action"];
|
||||
hasErrorBoundary?: AgnosticIndexRouteObject["hasErrorBoundary"];
|
||||
shouldRevalidate?: AgnosticIndexRouteObject["shouldRevalidate"];
|
||||
handle?: AgnosticIndexRouteObject["handle"];
|
||||
index: true;
|
||||
children?: undefined;
|
||||
element?: React.ReactNode | null;
|
||||
hydrateFallbackElement?: React.ReactNode | null;
|
||||
errorElement?: React.ReactNode | null;
|
||||
Component?: React.ComponentType | null;
|
||||
HydrateFallback?: React.ComponentType | null;
|
||||
ErrorBoundary?: React.ComponentType | null;
|
||||
lazy?: LazyRouteFunction<RouteObject>;
|
||||
}
|
||||
export interface NonIndexRouteObject {
|
||||
caseSensitive?: AgnosticNonIndexRouteObject["caseSensitive"];
|
||||
path?: AgnosticNonIndexRouteObject["path"];
|
||||
id?: AgnosticNonIndexRouteObject["id"];
|
||||
loader?: AgnosticNonIndexRouteObject["loader"];
|
||||
action?: AgnosticNonIndexRouteObject["action"];
|
||||
hasErrorBoundary?: AgnosticNonIndexRouteObject["hasErrorBoundary"];
|
||||
shouldRevalidate?: AgnosticNonIndexRouteObject["shouldRevalidate"];
|
||||
handle?: AgnosticNonIndexRouteObject["handle"];
|
||||
index?: false;
|
||||
children?: RouteObject[];
|
||||
element?: React.ReactNode | null;
|
||||
hydrateFallbackElement?: React.ReactNode | null;
|
||||
errorElement?: React.ReactNode | null;
|
||||
Component?: React.ComponentType | null;
|
||||
HydrateFallback?: React.ComponentType | null;
|
||||
ErrorBoundary?: React.ComponentType | null;
|
||||
lazy?: LazyRouteFunction<RouteObject>;
|
||||
}
|
||||
export type RouteObject = IndexRouteObject | NonIndexRouteObject;
|
||||
export type DataRouteObject = RouteObject & {
|
||||
children?: DataRouteObject[];
|
||||
id: string;
|
||||
};
|
||||
export interface RouteMatch<ParamKey extends string = string, RouteObjectType extends RouteObject = RouteObject> extends AgnosticRouteMatch<ParamKey, RouteObjectType> {
|
||||
}
|
||||
export interface DataRouteMatch extends RouteMatch<string, DataRouteObject> {
|
||||
}
|
||||
export interface DataRouterContextObject extends Omit<NavigationContextObject, "future"> {
|
||||
router: Router;
|
||||
staticContext?: StaticHandlerContext;
|
||||
}
|
||||
export declare const DataRouterContext: React.Context<DataRouterContextObject | null>;
|
||||
export declare const DataRouterStateContext: React.Context<import("@remix-run/router").RouterState | null>;
|
||||
export declare const AwaitContext: React.Context<TrackedPromise | null>;
|
||||
export interface NavigateOptions {
|
||||
replace?: boolean;
|
||||
state?: any;
|
||||
preventScrollReset?: boolean;
|
||||
relative?: RelativeRoutingType;
|
||||
flushSync?: boolean;
|
||||
viewTransition?: boolean;
|
||||
}
|
||||
/**
|
||||
* A Navigator is a "location changer"; it's how you get to different locations.
|
||||
*
|
||||
* Every history instance conforms to the Navigator interface, but the
|
||||
* distinction is useful primarily when it comes to the low-level `<Router>` API
|
||||
* where both the location and a navigator must be provided separately in order
|
||||
* to avoid "tearing" that may occur in a suspense-enabled app if the action
|
||||
* and/or location were to be read directly from the history instance.
|
||||
*/
|
||||
export interface Navigator {
|
||||
createHref: History["createHref"];
|
||||
encodeLocation?: History["encodeLocation"];
|
||||
go: History["go"];
|
||||
push(to: To, state?: any, opts?: NavigateOptions): void;
|
||||
replace(to: To, state?: any, opts?: NavigateOptions): void;
|
||||
}
|
||||
interface NavigationContextObject {
|
||||
basename: string;
|
||||
navigator: Navigator;
|
||||
static: boolean;
|
||||
future: {
|
||||
v7_relativeSplatPath: boolean;
|
||||
};
|
||||
}
|
||||
export declare const NavigationContext: React.Context<NavigationContextObject>;
|
||||
interface LocationContextObject {
|
||||
location: Location;
|
||||
navigationType: NavigationType;
|
||||
}
|
||||
export declare const LocationContext: React.Context<LocationContextObject>;
|
||||
export interface RouteContextObject {
|
||||
outlet: React.ReactElement | null;
|
||||
matches: RouteMatch[];
|
||||
isDataRoute: boolean;
|
||||
}
|
||||
export declare const RouteContext: React.Context<RouteContextObject>;
|
||||
export declare const RouteErrorContext: React.Context<any>;
|
||||
export {};
|
4
node_modules/react-router/dist/lib/deprecations.d.ts
generated
vendored
Normal file
4
node_modules/react-router/dist/lib/deprecations.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
import type { FutureConfig as RouterFutureConfig } from "@remix-run/router";
|
||||
import type { FutureConfig as RenderFutureConfig } from "./components";
|
||||
export declare function warnOnce(key: string, message: string): void;
|
||||
export declare function logV6DeprecationWarnings(renderFuture: Partial<RenderFutureConfig> | undefined, routerFuture?: Omit<RouterFutureConfig, "v7_prependBasename">): void;
|
181
node_modules/react-router/dist/lib/hooks.d.ts
generated
vendored
Normal file
181
node_modules/react-router/dist/lib/hooks.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,181 @@
|
|||
import * as React from "react";
|
||||
import type { Blocker, BlockerFunction, Location, ParamParseKey, Params, Path, PathMatch, PathPattern, RelativeRoutingType, Router as RemixRouter, RevalidationState, To, UIMatch } from "@remix-run/router";
|
||||
import { Action as NavigationType } from "@remix-run/router";
|
||||
import type { NavigateOptions, RouteContextObject, RouteMatch, RouteObject } from "./context";
|
||||
/**
|
||||
* Returns the full href for the given "to" value. This is useful for building
|
||||
* custom links that are also accessible and preserve right-click behavior.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-href
|
||||
*/
|
||||
export declare function useHref(to: To, { relative }?: {
|
||||
relative?: RelativeRoutingType;
|
||||
}): string;
|
||||
/**
|
||||
* Returns true if this component is a descendant of a `<Router>`.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-in-router-context
|
||||
*/
|
||||
export declare function useInRouterContext(): boolean;
|
||||
/**
|
||||
* Returns the current location object, which represents the current URL in web
|
||||
* browsers.
|
||||
*
|
||||
* Note: If you're using this it may mean you're doing some of your own
|
||||
* "routing" in your app, and we'd like to know what your use case is. We may
|
||||
* be able to provide something higher-level to better suit your needs.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-location
|
||||
*/
|
||||
export declare function useLocation(): Location;
|
||||
/**
|
||||
* Returns the current navigation action which describes how the router came to
|
||||
* the current location, either by a pop, push, or replace on the history stack.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-navigation-type
|
||||
*/
|
||||
export declare function useNavigationType(): NavigationType;
|
||||
/**
|
||||
* Returns a PathMatch object if the given pattern matches the current URL.
|
||||
* This is useful for components that need to know "active" state, e.g.
|
||||
* `<NavLink>`.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-match
|
||||
*/
|
||||
export declare function useMatch<ParamKey extends ParamParseKey<Path>, Path extends string>(pattern: PathPattern<Path> | Path): PathMatch<ParamKey> | null;
|
||||
/**
|
||||
* The interface for the navigate() function returned from useNavigate().
|
||||
*/
|
||||
export interface NavigateFunction {
|
||||
(to: To, options?: NavigateOptions): void;
|
||||
(delta: number): void;
|
||||
}
|
||||
/**
|
||||
* Returns an imperative method for changing the location. Used by `<Link>`s, but
|
||||
* may also be used by other elements to change the location.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-navigate
|
||||
*/
|
||||
export declare function useNavigate(): NavigateFunction;
|
||||
/**
|
||||
* Returns the context (if provided) for the child route at this level of the route
|
||||
* hierarchy.
|
||||
* @see https://reactrouter.com/v6/hooks/use-outlet-context
|
||||
*/
|
||||
export declare function useOutletContext<Context = unknown>(): Context;
|
||||
/**
|
||||
* Returns the element for the child route at this level of the route
|
||||
* hierarchy. Used internally by `<Outlet>` to render child routes.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-outlet
|
||||
*/
|
||||
export declare function useOutlet(context?: unknown): React.ReactElement | null;
|
||||
/**
|
||||
* Returns an object of key/value pairs of the dynamic params from the current
|
||||
* URL that were matched by the route path.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-params
|
||||
*/
|
||||
export declare function useParams<ParamsOrKey extends string | Record<string, string | undefined> = string>(): Readonly<[
|
||||
ParamsOrKey
|
||||
] extends [string] ? Params<ParamsOrKey> : Partial<ParamsOrKey>>;
|
||||
/**
|
||||
* Resolves the pathname of the given `to` value against the current location.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-resolved-path
|
||||
*/
|
||||
export declare function useResolvedPath(to: To, { relative }?: {
|
||||
relative?: RelativeRoutingType;
|
||||
}): Path;
|
||||
/**
|
||||
* Returns the element of the route that matched the current location, prepared
|
||||
* with the correct context to render the remainder of the route tree. Route
|
||||
* elements in the tree must render an `<Outlet>` to render their child route's
|
||||
* element.
|
||||
*
|
||||
* @see https://reactrouter.com/v6/hooks/use-routes
|
||||
*/
|
||||
export declare function useRoutes(routes: RouteObject[], locationArg?: Partial<Location> | string): React.ReactElement | null;
|
||||
export declare function useRoutesImpl(routes: RouteObject[], locationArg?: Partial<Location> | string, dataRouterState?: RemixRouter["state"], future?: RemixRouter["future"]): React.ReactElement | null;
|
||||
type RenderErrorBoundaryProps = React.PropsWithChildren<{
|
||||
location: Location;
|
||||
revalidation: RevalidationState;
|
||||
error: any;
|
||||
component: React.ReactNode;
|
||||
routeContext: RouteContextObject;
|
||||
}>;
|
||||
type RenderErrorBoundaryState = {
|
||||
location: Location;
|
||||
revalidation: RevalidationState;
|
||||
error: any;
|
||||
};
|
||||
export declare class RenderErrorBoundary extends React.Component<RenderErrorBoundaryProps, RenderErrorBoundaryState> {
|
||||
constructor(props: RenderErrorBoundaryProps);
|
||||
static getDerivedStateFromError(error: any): {
|
||||
error: any;
|
||||
};
|
||||
static getDerivedStateFromProps(props: RenderErrorBoundaryProps, state: RenderErrorBoundaryState): {
|
||||
error: any;
|
||||
location: Location<any>;
|
||||
revalidation: RevalidationState;
|
||||
};
|
||||
componentDidCatch(error: any, errorInfo: any): void;
|
||||
render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
|
||||
}
|
||||
export declare function _renderMatches(matches: RouteMatch[] | null, parentMatches?: RouteMatch[], dataRouterState?: RemixRouter["state"] | null, future?: RemixRouter["future"] | null): React.ReactElement | null;
|
||||
/**
|
||||
* Returns the ID for the nearest contextual route
|
||||
*/
|
||||
export declare function useRouteId(): string;
|
||||
/**
|
||||
* Returns the current navigation, defaulting to an "idle" navigation when
|
||||
* no navigation is in progress
|
||||
*/
|
||||
export declare function useNavigation(): import("@remix-run/router").Navigation;
|
||||
/**
|
||||
* Returns a revalidate function for manually triggering revalidation, as well
|
||||
* as the current state of any manual revalidations
|
||||
*/
|
||||
export declare function useRevalidator(): {
|
||||
revalidate: () => void;
|
||||
state: RevalidationState;
|
||||
};
|
||||
/**
|
||||
* Returns the active route matches, useful for accessing loaderData for
|
||||
* parent/child routes or the route "handle" property
|
||||
*/
|
||||
export declare function useMatches(): UIMatch[];
|
||||
/**
|
||||
* Returns the loader data for the nearest ancestor Route loader
|
||||
*/
|
||||
export declare function useLoaderData(): unknown;
|
||||
/**
|
||||
* Returns the loaderData for the given routeId
|
||||
*/
|
||||
export declare function useRouteLoaderData(routeId: string): unknown;
|
||||
/**
|
||||
* Returns the action data for the nearest ancestor Route action
|
||||
*/
|
||||
export declare function useActionData(): unknown;
|
||||
/**
|
||||
* Returns the nearest ancestor Route error, which could be a loader/action
|
||||
* error or a render error. This is intended to be called from your
|
||||
* ErrorBoundary/errorElement to display a proper error message.
|
||||
*/
|
||||
export declare function useRouteError(): unknown;
|
||||
/**
|
||||
* Returns the happy-path data from the nearest ancestor `<Await />` value
|
||||
*/
|
||||
export declare function useAsyncValue(): unknown;
|
||||
/**
|
||||
* Returns the error from the nearest ancestor `<Await />` value
|
||||
*/
|
||||
export declare function useAsyncError(): unknown;
|
||||
/**
|
||||
* Allow the application to block navigations within the SPA and present the
|
||||
* user a confirmation dialog to confirm the navigation. Mostly used to avoid
|
||||
* using half-filled form data. This does not handle hard-reloads or
|
||||
* cross-origin navigations.
|
||||
*/
|
||||
export declare function useBlocker(shouldBlock: boolean | BlockerFunction): Blocker;
|
||||
export {};
|
Loading…
Add table
Add a link
Reference in a new issue