@jirkasa/code-box
Version:
Showcase code samples on the web with a container that lets users select and display different samples.
74 lines (73 loc) • 2.67 kB
TypeScript
import CodeBoxBuilder from "../CodeBoxBuilder";
/** Builder of project code box. */
declare class ProjectCodeBoxBuilder implements CodeBoxBuilder {
/** Panel element. */
private panelElement;
/** Panel content container. */
private panelContentElement;
/** Panel open/close button. */
private panelOpenButton;
/** Folder structure heading element. */
private folderStructureHeadingElement;
/** Container for folder structure. */
private folderStructureContainer;
/** Horizontal rule between folder structure and packages section. */
private horizontalRule;
/** Packages heading element. */
private packagesHeadingElement;
/** Container for packages. */
private packagesContainer;
/**
* Creates new project code box builder.
* @param svgSpritePath Path to SVG sprite.
* @param openButtonIconName Name of panel open/close button icon.
*/
constructor(svgSpritePath?: string | null, openButtonIconName?: string | null);
/**
* Returns panel element.
* @returns Panel element.
*/
getPanelElement(): HTMLElement;
/**
* Returns panel content container.
* @returns Panel content container.
*/
getPanelContentElement(): HTMLElement;
/**
* Returns folder structure heading element.
* @returns Folder structure heading element.
*/
getFolderStructureHeadingElement(): HTMLElement;
/**
* Returns container for folder structure.
* @returns Container for folder structure.
*/
getFolderStructureContainer(): HTMLElement;
/**
* Returns horizontal rule between folder structure and packages section.
* @returns Horizontal rule between folder structure and packages section.
*/
getHorizontalRule(): HTMLElement;
/**
* Returns packages heading element.
* @returns Packages heading element.
*/
getPackagesHeadingElement(): HTMLElement;
/**
* Returns container for packages.
* @returns Container for packages.
*/
getPackagesContainer(): HTMLElement;
/**
* Returns panel open/close button.
* @returns Panel open/close button.
*/
getPanelOpenButtonElement(): HTMLButtonElement;
customizeRootElement(element: HTMLElement): void;
createCodeViewContainer(): HTMLElement;
getCodeViewContainerCSSHiddenClass(): string;
createNoCodeViewSelectedElement(height: string, text: string): HTMLElement;
getNoCodeViewCSSHiddenClass(): string;
assembleElements(rootElement: HTMLElement, codeViewContainer: HTMLElement, noCodeViewSelectedElement: HTMLElement): void;
}
export default ProjectCodeBoxBuilder;