json-edit-react 0.9.0

package/build/index.d.ts

@@ -0,0 +1,98 @@
+/// <reference types="react" />
+import React$1 from 'react';
+
+declare const themes: {
+    default: DefaultTheme;
+} & Record<string, Theme>;
+declare const themeableElements: readonly ["container", "property", "bracket", "itemCount", "string", "number", "boolean", "null", "input", "inputHighlight", "error", "iconCollection", "iconEdit", "iconDelete", "iconAdd", "iconCopy", "iconOk", "iconCancel"];
+type ThemeableElement = (typeof themeableElements)[number];
+type ThemeValue = string | React.CSSProperties | Array<string | React.CSSProperties>;
+type ThemeStyles = Record<ThemeableElement, ThemeValue>;
+type Fragments = Record<string, React.CSSProperties | string>;
+interface Theme {
+    displayName?: string;
+    fragments?: Fragments;
+    styles: Partial<ThemeStyles>;
+}
+interface DefaultTheme extends Theme {
+    displayName: 'Default';
+    styles: ThemeStyles;
+}
+type ThemeName = keyof typeof themes;
+type ThemeInput = ThemeName | Theme | Partial<ThemeStyles> | [ThemeName, Theme | Partial<ThemeStyles>];
+
+declare const localisedStrings: {
+    ITEM_SINGLE: string;
+    ITEMS_MULTIPLE: string;
+    KEY_NEW: string;
+    ERROR_KEY_EXISTS: string;
+    ERROR_INVALID_JSON: string;
+    ERROR_UPDATE: string;
+    ERROR_DELETE: string;
+    ERROR_ADD: string;
+};
+type LocalisedStrings = typeof localisedStrings;
+
+interface JsonEditorProps {
+    data: object;
+    rootName?: string;
+    onUpdate?: UpdateFunction;
+    onEdit?: UpdateFunction;
+    onDelete?: UpdateFunction;
+    onAdd?: UpdateFunction;
+    enableClipboard?: boolean | CopyFunction;
+    theme?: ThemeInput;
+    icons?: IconReplacements;
+    className?: string;
+    indent?: number;
+    collapse?: boolean | number | FilterFunction;
+    restrictEdit?: boolean | FilterFunction;
+    restrictDelete?: boolean | FilterFunction;
+    restrictAdd?: boolean | FilterFunction;
+    restrictKeyEdit?: boolean | FilterFunction;
+    keySort?: boolean | CompareFunction;
+    showArrayIndices?: boolean;
+    defaultValue?: unknown;
+    minWidth?: string | number;
+    maxWidth?: number;
+    stringTruncate?: number;
+    translations?: Partial<LocalisedStrings>;
+}
+type CollectionKey = string | number;
+type ErrorString = string;
+interface IconReplacements {
+    add?: JSX.Element;
+    edit?: JSX.Element;
+    delete?: JSX.Element;
+    copy?: JSX.Element;
+    ok?: JSX.Element;
+    cancel?: JSX.Element;
+    chevron?: JSX.Element;
+}
+type UpdateFunction = (props: {
+    newData: object;
+    currentData: object;
+    newValue: unknown;
+    currentValue: unknown;
+    name: CollectionKey;
+    path: CollectionKey[];
+}) => void | ErrorString | false;
+type FilterFunction = (input: {
+    key: CollectionKey;
+    path: CollectionKey[];
+    level: number;
+    value: unknown;
+    size: number | null;
+}) => boolean;
+type CopyType = 'path' | 'value';
+type CopyFunction = (input: {
+    key: CollectionKey;
+    path: CollectionKey[];
+    value: unknown;
+    type: CopyType;
+}) => void;
+type CompareFunction = (a: string, b: string) => number;
+
+declare const JsonEditor: React$1.FC<JsonEditorProps>;
+
+export { JsonEditor, Theme, ThemeName, themes };