@yamlresume/playground 0.11.0

package/dist/index.d.ts

@@ -0,0 +1,693 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { OnMount } from '@monaco-editor/react';
+import * as react from 'react';
+import { ReactNode, PropsWithChildren } from 'react';
+import { Resume, LayoutEngine } from '@yamlresume/core';
+
+/**
+ * Props for the Editor component.
+ */
+interface EditorProps {
+    /** The content of the editor. */
+    value: string;
+    /** Callback triggered when content changes. */
+    onChange?: (value: string | undefined) => void;
+    /** The language of the content. */
+    language: string;
+    /** Whether the editor is read-only. Defaults to false. */
+    readOnly?: boolean;
+    /** Whether to show line numbers. Defaults to true. */
+    lineNumbers?: boolean;
+    /** Whether to show the minimap. Defaults to true. */
+    /** Whether to show the minimap. Defaults to true. */
+    minimap?: boolean;
+    /** Callback triggered when the editor is mounted. */
+    onMount?: OnMount;
+}
+/**
+ * A shared editor component based on Monaco Editor.
+ * Encapsulates theme handling, common configuration, and LaTeX support.
+ *
+ * @param props - The component props.
+ * @returns The rendered Editor component.
+ */
+declare function Editor({ value, onChange, language, readOnly, lineNumbers, minimap, onMount, }: EditorProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * Props for the EditorPanel component.
+ */
+interface EditorPanelProps {
+    /** The current YAML content of the editor. */
+    value: string;
+    /** Callback triggered when the content changes. */
+    onChange: (value: string) => void;
+    /** The name of the file being edited. */
+    filename?: string;
+}
+/**
+ * A panel component containing the resume editor.
+ *
+ * @param props - The component props.
+ * @returns The rendered editor panel.
+ */
+declare function EditorPanel({ value, onChange, filename }: EditorPanelProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the ResumeEditor component.
+ */
+interface ResumeEditorProps {
+    /**
+     * The current value of the YAML resume.
+     */
+    value: string;
+    /**
+     * Callback triggered when the editor content changes.
+     * @param value - The new value of the editor content.
+     */
+    onChange: (value: string | undefined) => void;
+    /** Callback triggered when the editor is mounted. */
+    onMount?: OnMount;
+}
+/**
+ * A specialized editor component for editing the resume YAML content.
+ *
+ * This component wraps the shared {@link Editor} component, pre-configured
+ * for YAML editing.
+ *
+ * @param props - The component props.
+ * @param props.value - The string content to display in the editor.
+ * @param props.onChange - Handler called when content is modified.
+ * @returns The rendered editor component.
+ */
+declare function ResumeEditor({ value, onChange, onMount }: ResumeEditorProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * Props for the Playground component.
+ */
+interface PlaygroundProps {
+    /** YAML content for the playground editor. Defaults to DEFAULT_YAML. */
+    yaml?: string;
+    /** Callback triggered when the content changes. */
+    onChange?: (value: string) => void;
+    /** The name of the file being edited. */
+    filename?: string;
+}
+/**
+ * Main Playground component providing a split-view interface for editing and
+ * previewing resumes.
+ *
+ * On desktop (md+), shows side-by-side resizable panels.
+ * On mobile, shows a tab-based interface to switch between Editor and Preview.
+ *
+ * @param props - The component props.
+ * @returns The rendered Playground component.
+ */
+declare function Playground({ yaml: yamlStr, onChange, filename, }: PlaygroundProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the PlaygroundDesktop component.
+ */
+interface PlaygroundDesktopProps {
+    /** The editor panel content to render. */
+    editorPanel: ReactNode;
+    /** The preview panel content to render. */
+    previewPanel: ReactNode;
+}
+/**
+ * The desktop layout component for the playground.
+ * Shows a side-by-side resizable panel layout.
+ * This component is only visible on medium and larger screens (hidden on mobile).
+ *
+ * @param props - The component props.
+ * @returns The rendered desktop layout.
+ */
+declare function PlaygroundDesktop({ editorPanel, previewPanel, }: PlaygroundDesktopProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the PlaygroundMobile component.
+ */
+interface PlaygroundMobileProps {
+    /** The editor panel content to render. */
+    editorPanel: ReactNode;
+    /** The preview panel content to render. */
+    previewPanel: ReactNode;
+}
+/**
+ * The mobile layout component for the playground.
+ * Shows either the editor or preview panel based on the active tab.
+ * This component is only visible on small screens (hidden on md+).
+ *
+ * @param props - The component props.
+ * @returns The rendered mobile layout.
+ */
+declare function PlaygroundMobile({ editorPanel, previewPanel, }: PlaygroundMobileProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * Props for the CodeViewer component.
+ */
+interface CodeViewerProps {
+    /** The code content to display. */
+    content: string;
+    /** The language of the code (markdown or latex). */
+    language: 'markdown' | 'latex' | 'yaml';
+}
+/**
+ * Component to preview code (Markdown or LaTeX) using Monaco Editor.
+ *
+ * @param props - The props for the CodePreview component.
+ * @returns The rendered Monaco Editor.
+ */
+declare function CodeViewer({ content, language }: CodeViewerProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * Props for the HtmlViewer component.
+ */
+interface HtmlViewerProps {
+    /** The HTML content to render. */
+    content: string;
+}
+/**
+ * Component to preview HTML content in an iframe.
+ *
+ * @param props - The props for the HtmlPreview component.
+ * @returns The rendered iframe element.
+ */
+declare function HtmlViewer({ content }: HtmlViewerProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the PreviewPanel component.
+ */
+interface PreviewPanelProps {
+    /** The index of the currently active layout. */
+    activeLayoutIndex: number;
+    /** The name of the file being edited. */
+    filename?: string;
+    /** The parsed resume object. */
+    resume: Resume | null;
+    /** Callback to change the active layout index. */
+    setActiveLayoutIndex: (index: number) => void;
+}
+/**
+ * A panel component containing the resume preview, layout selector tabs, and actions.
+ *
+ * @param props - The component props.
+ * @returns The rendered preview panel.
+ */
+declare function PreviewPanel({ activeLayoutIndex, filename, resume, setActiveLayoutIndex, }: PreviewPanelProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the ResumeViewer component.
+ */
+interface ResumeViewerProps {
+    /** The pre-parsed resume object. */
+    resume: Resume | null;
+    /** The index of the layout to use for rendering. */
+    layoutIndex: number;
+}
+/**
+ * ResumeViewer component responsible for rendering the appropriate preview
+ * (HTML, Markdown, or LaTeX) based on the selected layout.
+ *
+ * @param props - The props for the ResumeViewer component.
+ * @returns The rendered ResumeViewer component.
+ */
+declare function ResumeViewer({ resume, layoutIndex }: ResumeViewerProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * A styled panel container component for the Playground.
+ *
+ * Provides consistent styling including:
+ * - Flexbox layout for content organization
+ * - Shadow effect for visual depth
+ * - Border styling for clear boundaries
+ *
+ * @param props - The component props.
+ * @returns The rendered panel container.
+ */
+declare function Panel({ children }: PropsWithChildren): react_jsx_runtime.JSX.Element;
+
+/**
+ * A shared container for panel content.
+ * Provides a flexible layout for the main content area of a panel.
+ *
+ * @param props - The component props.
+ * @returns The rendered content container.
+ */
+declare function PanelContent({ children }: PropsWithChildren): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * A separator component for the Playground.
+ *
+ * @returns The rendered separator.
+ */
+declare function PanelSeparator(): react_jsx_runtime.JSX.Element;
+
+/**
+ * A shared toolbar component for panels.
+ *
+ * @param props - The component props.
+ * @returns The rendered toolbar.
+ */
+declare function PanelToolbar({ children }: PropsWithChildren): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the ToolbarButton component.
+ */
+interface ToolbarButtonProps {
+    /** Callback triggered when the button is clicked. */
+    onClick: () => void;
+    /** The content to be rendered inside the button, typically an icon. */
+    children: ReactNode;
+    /** The tooltip text displayed when hovering over the button. */
+    title: string;
+}
+/**
+ * A generic button component used in the playground toolbar.
+ *
+ * It provides consistent styling and behavior for all toolbar actions.
+ *
+ * @param props - The component props.
+ * @returns The rendered toolbar button.
+ */
+declare function ToolbarButton({ onClick, children, title, }: ToolbarButtonProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * Props for the ToolbarCopyButton component.
+ */
+interface ToolbarCopyButtonProps {
+    /** Callback triggered to perform the copy action. Can be async. */
+    onClick: () => Promise<void> | void;
+    /** The tooltip text. Defaults to 'Copy'. */
+    title?: string;
+}
+/**
+ * A toolbar button for copying content to the clipboard.
+ * It temporarily changes the icon to a checkmark upon successful copy.
+ *
+ * @param props - The component props.
+ * @returns The rendered copy button.
+ */
+declare function ToolbarCopyButton({ onClick, title, }: ToolbarCopyButtonProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+/**
+ * A toolbar separator component.
+ *
+ * @returns The rendered separator.
+ */
+declare function ToolbarSeparator(): react_jsx_runtime.JSX.Element;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+declare const ICON_SIZES: {
+    xs: number;
+    sm: number;
+    md: number;
+    lg: number;
+    xl: number;
+};
+declare const ICON_STROKES: {
+    xs: number;
+    sm: number;
+    md: number;
+    lg: number;
+    xl: number;
+};
+declare const EDITOR_BG_COLOR = "#1e1e1e";
+declare const EDITOR_FONT_SIZE = 14;
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/**
+ * Props for the `useResumeRenderer` hook.
+ *
+ * @property {Resume | null} resume - The pre-parsed resume object to render.
+ *   Pass `null` when the resume is not yet available or parsing failed.
+ * @property {number} layoutIndex - The index of the layout to use for rendering.
+ *   Must be a valid index within the `resume.layouts` array.
+ */
+interface UseResumeRendererProps {
+    resume: Resume | null;
+    layoutIndex: number;
+}
+/**
+ * A React hook for rendering a resume using a specified layout.
+ *
+ * @description
+ * This hook encapsulates the logic for:
+ * - Selecting the appropriate layout from the resume's layouts array
+ * - Determining the rendering engine (html, markdown, or latex)
+ * - Generating the rendered output content
+ * - Handling errors gracefully during rendering
+ *
+ * The hook re-renders when either the `resume` object or `layoutIndex` changes.
+ * If `resume` is `null`, no rendering is performed.
+ *
+ * @param {UseResumeRendererProps} props - Configuration options for the hook.
+ * @returns An object containing:
+ *   - `renderedContent` - The rendered resume content as a string
+ *   - `engine` - The rendering engine used ('html', 'markdown', or 'latex')
+ *   - `error` - Error message if rendering failed, or `null` if successful
+ *
+ * @example
+ * const { renderedContent, engine, error } = useResumeRenderer({
+ *   resume: parsedResume,
+ *   layoutIndex: 0,
+ * })
+ *
+ * if (error) {
+ *   return <ErrorDisplay message={error} />
+ * }
+ *
+ * return engine === 'html'
+ *   ? <HtmlViewer content={renderedContent} />
+ *   : <CodeViewer content={renderedContent} language={engine} />
+ */
+declare function useResumeRenderer({ resume, layoutIndex, }: UseResumeRendererProps): {
+    renderedContent: string;
+    engine: LayoutEngine;
+    error: string;
+};
+
+/**
+ * Props for the `useResumeState` hook.
+ *
+ * @property {string} [yaml] - The YAML content for the resume editor.
+ *   Defaults to `DEFAULT_YAML` if not provided. Parent component should
+ *   manage this state and update it via the `onChange` callback.
+ * @property {(value: string) => void} [onChange] - Callback invoked when
+ *   the YAML content changes. The parent should update its state accordingly.
+ */
+interface UseResumeStateProps {
+    yaml?: string;
+    onChange?: (value: string) => void;
+}
+/**
+ * A React hook for managing resume state derived from YAML content.
+ *
+ * @description
+ * This hook encapsulates the logic for:
+ * - Parsing YAML into a `Resume` object with memoization
+ * - Tracking the active layout index with bounds checking
+ * - Providing a change handler that notifies the parent
+ *
+ * The parent component is responsible for managing the YAML state.
+ * This hook simply derives state (parsed resume, layout index) from the
+ * provided YAML and exposes utilities for updates.
+ *
+ * @param {UseResumeStateProps} props - Configuration options for the hook.
+ * @returns An object containing:
+ *   - `yaml` - The current YAML string content
+ *   - `handleYamlChange` - Function to notify parent of YAML changes
+ *   - `activeLayoutIndex` - The currently selected layout index
+ *   - `setActiveLayoutIndex` - Function to change the active layout
+ *   - `resume` - The parsed `Resume` object (or `null` if parsing fails)
+ *
+ * @example
+ * // Parent manages state, hook derives resume object
+ * const [yaml, setYaml] = useState(defaultYaml)
+ * const { resume, activeLayoutIndex } = useResumeState({
+ *   yaml,
+ *   onChange: setYaml,
+ * })
+ */
+declare function useResumeState({ yaml, onChange, }: UseResumeStateProps): {
+    yaml: string;
+    handleYamlChange: (v: string) => void;
+    activeLayoutIndex: number;
+    setActiveLayoutIndex: react.Dispatch<react.SetStateAction<number>>;
+    resume: Resume;
+};
+
+/**
+ * MIT License
+ *
+ * Copyright (c) 2023–Present PPResume (https://ppresume.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/**
+ * Gets the basename from a filepath.
+ *
+ * @param filepath - The file path (e.g. "path/to/resume.yaml").
+ * @param removeExtension - Whether to remove the file extension.
+ * @returns The basename of the file.
+ */
+declare const getBasename: (filepath?: string, removeExtension?: boolean) => string;
+/**
+ * Gets the file extension for a given rendering engine.
+ *
+ * @param engine - The rendering engine (html, latex, markdown).
+ * @returns The associated file extension.
+ */
+declare const getExtension: (engine: LayoutEngine) => string;
+/**
+ * Downloads the resume for a specific layout index.
+ *
+ * @param resume - The resume object.
+ * @param layoutIndex - The index of the layout to download.
+ */
+declare const downloadResume: (resume: Resume | null, layoutIndex: number) => void;
+/**
+ * Copies the resume content to the clipboard for a specific layout index.
+ *
+ * @param resume - The resume object.
+ * @param layoutIndex - The index of the layout to copy.
+ */
+declare const copyResumeToClipboard: (resume: Resume | null, layoutIndex: number) => Promise<void>;
+/**
+ * Prints the resume content (only for HTML layouts).
+ *
+ * @param resume - The resume object.
+ * @param layoutIndex - The index of the layout to print.
+ */
+declare const printResume: (resume: Resume | null, layoutIndex: number) => void;
+/**
+ * Opens the resume content in a new tab (only for HTML layouts).
+ *
+ * @param resume - The resume object.
+ * @param layoutIndex - The index of the layout to open.
+ */
+declare const openResumeInNewTab: (resume: Resume | null, layoutIndex: number) => void;
+
+export { CodeViewer, type CodeViewerProps, EDITOR_BG_COLOR, EDITOR_FONT_SIZE, Editor, EditorPanel, type EditorPanelProps, type EditorProps, HtmlViewer, type HtmlViewerProps, ICON_SIZES, ICON_STROKES, Panel, PanelContent, PanelSeparator, PanelToolbar, Playground, PlaygroundDesktop, type PlaygroundDesktopProps, PlaygroundMobile, type PlaygroundMobileProps, type PlaygroundProps, PreviewPanel, type PreviewPanelProps, ResumeEditor, type ResumeEditorProps, ResumeViewer, type ResumeViewerProps, ToolbarButton, ToolbarCopyButton, ToolbarSeparator, type UseResumeRendererProps, type UseResumeStateProps, copyResumeToClipboard, downloadResume, getBasename, getExtension, openResumeInNewTab, printResume, useResumeRenderer, useResumeState };