@umami/shiso 1.12.0 → 1.14.0

package/types/components.d.ts

@@ -146,18 +146,6 @@ export interface IconProps {
 
 export declare function Icon(props: IconProps): ReactElement | null;
 
-export interface ParamFieldProps {
-  name?: string;
-  query?: string;
-  path?: string;
-  header?: string;
-  body?: string;
-  type?: string;
-  required?: boolean;
-  children?: ReactNode;
-}
-
-export declare function ParamField(props: ParamFieldProps): ReactElement;
 export declare function Param(props: ChildrenProps): ReactElement;
 
 export interface PropertiesTableProps {
@@ -168,7 +156,7 @@ export declare function PropertiesTable(props: PropertiesTableProps): ReactEleme
 
 type FieldValue = string | number | boolean | null | undefined;
 
-export interface ResponseFieldProps {
+export interface PropertiesTableRowProps {
   name: string;
   type?: FieldValue;
   default?: FieldValue;
@@ -177,7 +165,9 @@ export interface ResponseFieldProps {
   children?: ReactNode;
 }
 
-export declare function ResponseField(props: ResponseFieldProps): ReactElement;
+export declare namespace PropertiesTable {
+  function Row(props: PropertiesTableRowProps): ReactElement;
+}
 
 export interface StepProps {
   title?: ReactNode;
@@ -211,6 +201,85 @@ export interface TooltipProps {
 
 export declare function Tooltip(props: TooltipProps): ReactElement;
 
+export interface UpdateRss {
+  title?: string;
+  description?: string;
+}
+
+export interface UpdateProps {
+  label: string;
+  description?: ReactNode;
+  tags?: string[];
+  rss?: UpdateRss;
+  children?: ReactNode;
+}
+
+export declare function Update(props: UpdateProps): ReactElement;
+
+export interface ChangelogProps {
+  children?: ReactNode;
+}
+
+export declare function Changelog(props: ChangelogProps): ReactElement;
+
+export type MermaidPlacement = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+
+export interface MermaidProps {
+  chart?: string;
+  title?: ReactNode;
+  actions?: boolean;
+  placement?: MermaidPlacement;
+  children?: ReactNode;
+}
+
+export declare function Mermaid(props: MermaidProps): ReactElement;
+
+export interface PanelProps {
+  children?: ReactNode;
+}
+
+export declare function Panel(props: PanelProps): ReactElement;
+
+export interface TileProps {
+  href: string;
+  title?: ReactNode;
+  description?: ReactNode;
+  children: ReactNode;
+  target?: '_self' | '_blank';
+}
+
+export interface TilesProps {
+  children?: ReactNode;
+  cols?: 1 | 2 | 3 | 4;
+}
+
+export declare function Tile(props: TileProps): ReactElement;
+export declare function Tiles(props: TilesProps): ReactElement;
+
+export interface TreeFolderProps {
+  name: string;
+  defaultOpen?: boolean;
+  openable?: boolean;
+  highlight?: boolean;
+  children?: ReactNode;
+}
+
+export interface TreeFileProps {
+  name: string;
+  highlight?: boolean;
+}
+
+export interface TreeProps {
+  children?: ReactNode;
+  style?: React.CSSProperties;
+  className?: string;
+}
+
+export declare function Tree(props: TreeProps): ReactElement;
+export declare function FileTree(props: TreeProps): ReactElement;
+export declare function TreeFolder(props: TreeFolderProps): ReactElement;
+export declare function TreeFile(props: TreeFileProps): ReactElement;
+
 export interface ZoomableImageProps extends ImgHTMLAttributes<HTMLImageElement> {
   noZoom?: boolean;
 }

package/src/components/docs/ParamField.tsx

@@ -1,45 +0,0 @@
-import type { ReactNode } from 'react';
-import { Badge } from './Badge';
-import { styles } from './styles';
-import { decodeHtmlEntities } from './utils';
-
-export interface ParamFieldProps {
-  name?: string;
-  query?: string;
-  path?: string;
-  header?: string;
-  body?: string;
-  type?: string;
-  required?: boolean;
-  children?: ReactNode;
-}
-
-export function ParamField({
-  name,
-  query,
-  path,
-  header,
-  body,
-  type,
-  required,
-  children,
-}: ParamFieldProps) {
-  const label = name || query || path || header || body || 'parameter';
-  const location = query ? 'query' : path ? 'path' : header ? 'header' : body ? 'body' : undefined;
-
-  return (
-    <div className={styles.paramField}>
-      <div className={styles.fieldHeader}>
-        <span className={styles.fieldName}>{label}</span>
-        {location ? <Badge>{location}</Badge> : null}
-        {type ? <span className={styles.fieldType}>{decodeHtmlEntities(type)}</span> : null}
-        {required ? <Badge tone="primary">required</Badge> : null}
-      </div>
-      {children ? <div className={styles.fieldBody}>{children}</div> : null}
-    </div>
-  );
-}
-
-export function Param({ children }: { children?: ReactNode }) {
-  return <code className={styles.code}>{children}</code>;
-}

package/src/components/docs/ResponseField.tsx

@@ -1,36 +0,0 @@
-import type { ReactNode } from 'react';
-import { Badge } from './Badge';
-import { styles } from './styles';
-import { decodeHtmlEntities } from './utils';
-
-type FieldValue = string | number | boolean | null | undefined;
-
-export interface ResponseFieldProps {
-  name: string;
-  type?: FieldValue;
-  default?: FieldValue;
-  required?: boolean;
-  deprecated?: boolean;
-  children?: ReactNode;
-}
-
-export function ResponseField({ name, type, required, deprecated, children }: ResponseFieldProps) {
-  const normalizedType =
-    typeof type === 'string'
-      ? decodeHtmlEntities(type)
-      : type === undefined || type === null
-        ? undefined
-        : String(type);
-
-  return (
-    <div className={styles.field}>
-      <div className={styles.fieldHeader}>
-        <span className={styles.fieldName}>{name}</span>
-        {normalizedType ? <span className={styles.fieldType}>{normalizedType}</span> : null}
-        {required ? <Badge tone="primary">required</Badge> : null}
-        {deprecated ? <Badge>deprecated</Badge> : null}
-      </div>
-      {children ? <div className={styles.fieldBody}>{children}</div> : null}
-    </div>
-  );
-}