UNPKG

@hypothesis/frontend-shared

Version:

Shared components, styles and utilities for Hypothesis projects

31 lines (30 loc) 1.28 kB
/** * @typedef {import("../routes").PlaygroundRoute} PlaygroundRoute * @typedef {import("../routes").PlaygroundRouteGroup} PlaygroundRouteGroup * @typedef {import('preact').ComponentChildren} Children */ /** * @typedef PlaygroundAppProps * @prop {string} [baseURL] * @prop {PlaygroundRoute[]} [extraRoutes] - Local-/application-specific routes * to add to this pattern library in addition to the shared/common routes */ /** * Render web content for the playground application. This includes the "frame" * around the page and a navigation channel, as well as the content rendered * by the component handling the current route. * * @param {PlaygroundAppProps} props */ export default function PlaygroundApp({ baseURL, extraRoutes, }: PlaygroundAppProps): import("preact").JSX.Element; export type PlaygroundRoute = import("../routes").PlaygroundRoute; export type PlaygroundRouteGroup = import("../routes").PlaygroundRouteGroup; export type Children = import('preact').ComponentChildren; export type PlaygroundAppProps = { baseURL?: string | undefined; /** * - Local-/application-specific routes * to add to this pattern library in addition to the shared/common routes */ extraRoutes?: import("../routes").PlaygroundRoute[] | undefined; };