@sqrzro/admin 1.0.0-beta.7 → 2.0.0

package/dist/types/core/ListItemTitle/index.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-interface ListItemTitleProps {
-    children: React.ReactNode;
-    isPreload?: boolean;
-    onClick?: React.MouseEventHandler<HTMLAnchorElement | HTMLHeadingElement>;
-    to?: string | null;
-}
-declare const ListItemTitle: React.FunctionComponent<ListItemTitleProps>;
-export default ListItemTitle;

package/dist/types/core/Loader/index.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-interface LoaderProps {
-    isMini?: boolean;
-}
-declare const Loader: React.FunctionComponent<LoaderProps>;
-export default Loader;

package/dist/types/core/LoginFormTwoFactor/index.d.ts

@@ -1,13 +0,0 @@
-import React from 'react';
-interface LoginFormTwoFactorFields {
-    provider: string;
-    twofactor_code: string;
-}
-interface LoginFormTwoFactorProps<T = LoginFormTwoFactorFields> {
-    formData: T;
-    isLoading: boolean;
-    onSubmit: (event?: React.FormEvent<HTMLFormElement>) => void;
-    setFormData: (key: keyof T, value: T[keyof T]) => void;
-}
-declare const LoginFormTwoFactor: ({ formData, isLoading, onSubmit, setFormData, }: LoginFormTwoFactorProps) => React.ReactElement;
-export default LoginFormTwoFactor;

package/dist/types/core/MeActions/index.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const MeActions: React.FunctionComponent;
-export default MeActions;

package/dist/types/core/Modal/index.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import type { StyleVariant } from '../../utility/interfaces';
-export interface ModalProps {
-    children: React.ReactNode;
-    isOpen?: boolean;
-    title?: string;
-    variant?: StyleVariant;
-    width?: string;
-    onClose?: React.MouseEventHandler<HTMLButtonElement>;
-}
-declare const Modal: React.FunctionComponent<ModalProps>;
-export default Modal;

package/dist/types/core/ModalComponent/index.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import type { StyleVariant } from '../../utility/interfaces';
-export interface ModalComponentProps {
-    children: React.ReactNode;
-    isOpen?: boolean;
-    onClose?: React.MouseEventHandler<HTMLButtonElement>;
-    title?: string;
-    variant?: StyleVariant;
-    width?: string;
-}
-declare const ModalComponent: React.FunctionComponent<ModalComponentProps>;
-export default ModalComponent;

package/dist/types/core/NavigationItem/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import type { NavigationObject } from '../../utility/interfaces';
-interface NavigationItemProps extends NavigationObject {
-    isActive?: boolean;
-}
-declare const NavigationItem: React.FunctionComponent<NavigationItemProps>;
-export default NavigationItem;

package/dist/types/core/Pagination/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import type { PaginationObject } from '../../utility/interfaces';
-interface PaginationProps extends PaginationObject {
-    isDisabled?: boolean;
-}
-declare const Pagination: React.FunctionComponent<PaginationProps>;
-export default Pagination;

package/dist/types/core/PaginationItem/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-interface PaginationItemProps {
-    activePage: number;
-    pageNumber: number | '-';
-}
-declare const PaginationItem: React.FunctionComponent<PaginationItemProps>;
-export default PaginationItem;

package/dist/types/core/Panel/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-interface PanelProps {
-    children: React.ReactNode;
-    isPadded?: boolean;
-    isSpaced?: boolean;
-}
-declare const Panel: React.FunctionComponent<PanelProps>;
-export default Panel;

package/dist/types/core/RadialProgress/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-interface RadialProgressProps {
-    duration: number;
-    icon: string;
-    variant?: string;
-}
-declare const RadialProgress: React.FunctionComponent<RadialProgressProps>;
-export default RadialProgress;

package/dist/types/core/SettingsForm/index.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const SettingsForm: () => React.ReactElement;
-export default SettingsForm;

package/dist/types/core/StaticTextInput/index.d.ts

@@ -1,13 +0,0 @@
-import React from 'react';
-import type { InputEvent, InputProps, InputValue } from '../../utility/interfaces';
-interface StaticTextInputProps extends Omit<InputProps<InputValue, InputValue, HTMLButtonElement>, 'onChange'> {
-    icon?: string;
-    isOpen?: boolean;
-    isOptional?: boolean;
-    label?: string | null;
-    onChange?: (event: InputEvent<string>) => void;
-    onClick?: React.MouseEventHandler<HTMLButtonElement>;
-    placeholder?: string;
-}
-declare const StaticTextInput: React.FunctionComponent<StaticTextInputProps>;
-export default StaticTextInput;

package/dist/types/core/SummaryListItem/index.d.ts

@@ -1,15 +0,0 @@
-import React from 'react';
-interface SummaryListItemDefinition {
-    key?: string;
-    label?: string;
-    render?: (key: string) => React.ReactNode;
-    to?: string | null;
-    type?: string;
-}
-export declare type SummaryListValue = SummaryListItemDefinition | number | string;
-export interface SummaryListObject {
-    label: string;
-    value: SummaryListValue;
-}
-declare const SummaryListItem: React.FunctionComponent<SummaryListObject>;
-export default SummaryListItem;

package/dist/types/core/TableCell/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-export declare type Columns = Record<string, string | [string, boolean?]>;
-interface TableCellProps {
-    value?: React.ReactElement | string;
-    isRightAligned?: boolean;
-}
-declare const TableCell: React.FunctionComponent<TableCellProps>;
-export default TableCell;

package/dist/types/core/TableHead/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import type { TransformedColumn } from '../TableRow';
-interface TableHeadProps {
-    hasActions?: boolean;
-    columns: TransformedColumn[];
-}
-declare const TableHead: React.FunctionComponent<TableHeadProps>;
-export default TableHead;

package/dist/types/core/Tabs/index.d.ts

@@ -1,11 +0,0 @@
-import React from 'react';
-export interface TabItem {
-    label: string;
-    route: string;
-    isDisabled?: boolean | ((item: TabItem, sceneData: Record<string, unknown>) => boolean) | null;
-}
-interface TabsProps {
-    data: TabItem[];
-}
-export declare const Tabs: React.FunctionComponent<TabsProps>;
-export default Tabs;

package/dist/types/core/TextInputAncillary/index.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-interface TextInputAncillaryProps {
-    hasError?: boolean;
-    isClearable?: boolean;
-    isLoading?: boolean;
-    onClear: () => void;
-    prefix?: string | null;
-    suffix?: string | null;
-    value: string;
-}
-declare const TextInputAncillary: React.FunctionComponent<TextInputAncillaryProps>;
-export default TextInputAncillary;

package/dist/types/core/WeekCalendarDay/index.d.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-interface DataItem {
-    id: number;
-    datetime: string;
-    patient: {
-        name: string;
-    };
-}
-interface WeekCalendarDayProps {
-    data?: DataItem[] | null;
-    date: Date;
-}
-declare const WeekCalendarDay: React.FunctionComponent<WeekCalendarDayProps>;
-export default WeekCalendarDay;

package/dist/types/filters/BooleanFilter/index.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import type { FilterFieldProps, RenderSummaryArgs } from '../interfaces';
-declare const BooleanFilter: React.FunctionComponent<FilterFieldProps>;
-export declare const renderSummary: ({ data, value }: RenderSummaryArgs) => string;
-export default BooleanFilter;

package/dist/types/filters/DateFilter/index.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import type { FilterFieldProps, RenderSummaryArgs } from '../interfaces';
-declare const DateFilter: ({ value, ...props }: FilterFieldProps) => React.ReactElement;
-export declare const renderSummary: ({ value }: RenderSummaryArgs) => string;
-export default DateFilter;

package/dist/types/filters/DropdownFilter/index.d.ts

@@ -1,17 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import type { FilterFieldProps, RenderSummaryArgs } from '../interfaces';
-declare const DropdownFilter: {
-    ({ data, extraProps, ...props }: FilterFieldProps): React.ReactElement;
-    propTypes: {
-        data: PropTypes.Requireable<string[] | PropTypes.InferProps<{
-            id: PropTypes.Validator<string | number>;
-            name: PropTypes.Validator<string>;
-        }>[]>;
-        extraProps: PropTypes.Requireable<PropTypes.InferProps<{
-            isMultiple: PropTypes.Requireable<boolean>;
-        }>>;
-    };
-};
-export declare const renderSummary: ({ data, value }: RenderSummaryArgs) => string;
-export default DropdownFilter;

package/dist/types/filters/QuickDateFilter/index.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import type { FilterFieldProps, RenderSummaryArgs } from '../interfaces';
-export declare const renderSummary: ({ value }: RenderSummaryArgs) => string;
-declare const QuickDateFilter: React.FunctionComponent<FilterFieldProps>;
-export default QuickDateFilter;

package/dist/types/hooks/useAccessiblePanel.d.ts

@@ -1,13 +0,0 @@
-import type { KeyboardEventHandler } from 'react';
-import type { InputEvent, StrictSimpleObject } from '../utility/interfaces';
-interface UseAccessiblePanelArgs {
-    data?: StrictSimpleObject[];
-    name: string;
-    onChange?: (event: InputEvent<string>) => void;
-    value?: (number | string)[] | number | string;
-}
-interface UseAccessiblePanelReturn<T> {
-    handleKeyboard: KeyboardEventHandler<T>;
-}
-declare const useAccessiblePanel: <E = HTMLInputElement | HTMLButtonElement>({ data, name, onChange, value, }: UseAccessiblePanelArgs) => UseAccessiblePanelReturn<E>;
-export default useAccessiblePanel;

package/dist/types/hooks/useAppContext.d.ts

@@ -1,55 +0,0 @@
-/// <reference types="react" />
-import type { NavigationObject } from '../utility/interfaces';
-export interface Me {
-    name: string;
-    permissions?: string[];
-}
-export declare enum AppLayout {
-    sidebar = "sidebar",
-    topbar = "topbar"
-}
-export declare enum AuthIdentifier {
-    email = "email",
-    username = "username"
-}
-export interface AuthObject {
-    identifier: AuthIdentifier;
-    identifierLabel: string;
-    loginUrl: string;
-    meUrl: string;
-    passwordUrl: string;
-    tfa: boolean;
-}
-export interface AppContextObject {
-    auth: AuthObject;
-    Logo?: React.ComponentType;
-    me?: Me;
-    name: string;
-    navigation: (NavigationObject | string)[];
-    paths: {
-        api: string;
-    };
-    style: {
-        brand?: string;
-        isDarkMode?: boolean;
-        layout: AppLayout;
-    };
-}
-export interface Config {
-    auth?: Partial<AppContextObject['auth']>;
-    Logo?: AppContextObject['Logo'];
-    me?: AppContextObject['me'];
-    name: string;
-    navigation?: AppContextObject['navigation'];
-    paths?: Partial<AppContextObject['paths']>;
-    style?: Partial<AppContextObject['style']>;
-}
-export declare const defaultAppContext: AppContextObject;
-export declare const getAppContextFromConfig: (config: Config) => AppContextObject;
-interface AppContextProviderProps {
-    children: React.ReactNode;
-    value: AppContextObject;
-}
-export declare const AppContextProvider: ({ children, value, }: AppContextProviderProps) => React.ReactElement;
-declare const useAppContext: () => AppContextObject;
-export default useAppContext;

package/dist/types/hooks/useClickOutside.d.ts

@@ -1,3 +0,0 @@
-import type { MutableRefObject } from 'react';
-declare const useClickOutside: () => [boolean, (bool: boolean) => void, MutableRefObject<HTMLDivElement | null>];
-export default useClickOutside;

package/dist/types/hooks/useComponentId.d.ts

@@ -1,2 +0,0 @@
-declare const useComponentId: () => string;
-export default useComponentId;

package/dist/types/hooks/useFilters.d.ts

@@ -1,3 +0,0 @@
-import type { FilterMap, FilterOptions } from '../services/FilterService';
-declare const useFilters: (options?: FilterOptions | undefined) => [FilterMap, (data: FilterMap) => void];
-export default useFilters;

package/dist/types/hooks/useForm.d.ts

@@ -1,41 +0,0 @@
-/// <reference types="react" />
-import type { ApiMethod, ApiResponse, ApiUrl } from '@sqrzro/utility';
-import type { InputEvent } from '../utility/interfaces';
-interface FormProps {
-    children: React.ReactNode;
-    onSubmit: (event?: React.FormEvent<HTMLFormElement>) => void;
-}
-/**
- * Why the `$` before `onChange`. To enable fields to have additional `onChange` behaviour, but
- * still let `useForm` handle the basics of changing the `formData`. This behaviour is handled in
- * the `FormField` component.
- */
-interface FieldPropsReturn<T, K extends keyof T = keyof T> {
-    error?: string;
-    name: string;
-    $onChange: (event: InputEvent) => void;
-    value: T[K];
-}
-interface UseFormArgs<T, R> {
-    defaults?: T;
-    errorMessage?: string | false;
-    hasFieldErrors?: boolean;
-    method?: ApiMethod;
-    onSubmitError?: (error: unknown, formData?: T, setFormData?: (key: keyof T, value: T[keyof T]) => void) => void;
-    onSubmitSuccess?: (response: ApiResponse<R>, formData?: T, setFormData?: (key: keyof T, value: T[keyof T]) => void) => void;
-    successMessage?: string | false;
-    transformErrors?: (errors: Record<string, string>) => Record<string, string>;
-    transformRequest?: (data: T) => Record<string, unknown>;
-    url?: ApiUrl;
-}
-export interface UseFormReturn<T> {
-    errors: Record<string, string>;
-    fieldProps: <K extends keyof T>(name: K) => FieldPropsReturn<T, K>;
-    formData: T;
-    formProps: Omit<FormProps, 'children'>;
-    handleSubmit: (event?: React.FormEvent<HTMLFormElement>) => void;
-    isLoading: boolean;
-    setFormData: (key: keyof T, value: T[keyof T]) => void;
-}
-declare const useForm: <T extends object, R = T>({ defaults, errorMessage, hasFieldErrors, method, onSubmitError, onSubmitSuccess, successMessage, transformErrors, transformRequest, url, }: UseFormArgs<T, R>) => UseFormReturn<T>;
-export default useForm;

package/dist/types/hooks/useFormData.d.ts

@@ -1,12 +0,0 @@
-import type { InputValue } from '../utility/interfaces';
-export interface FormDataArgs {
-    data?: Record<string, InputValue>;
-    defaults?: Record<string, InputValue>;
-    fields?: string[];
-}
-export interface FormDataObject {
-    data: Record<string, InputValue>;
-    setData: (key: string, value: InputValue) => void;
-}
-declare const useFormData: ({ data, defaults, fields }: FormDataArgs) => FormDataObject;
-export default useFormData;

package/dist/types/hooks/useModalOffset.d.ts

@@ -1,2 +0,0 @@
-declare const useModalOffset: (property: string) => Record<string, string>;
-export default useModalOffset;

package/dist/types/hooks/useVariant.d.ts

@@ -1,6 +0,0 @@
-import type { StyleVariant } from '../utility/interfaces';
-interface UseVariantReturn {
-    applyVariantClassName: (styles: Record<string, string>, prefix?: string) => string | null;
-}
-declare const useVariant: <T = StyleVariant>(variant?: T | T[] | undefined) => UseVariantReturn;
-export default useVariant;

package/dist/types/services/BuildService.d.ts

@@ -1,5 +0,0 @@
-declare const BuildService: {
-    start: () => Promise<void>;
-    open: () => boolean;
-};
-export default BuildService;

package/dist/types/services/DateService.d.ts

@@ -1,17 +0,0 @@
-import type { StrictSimpleObject } from '../utility/interfaces';
-interface DateItem {
-    id: number;
-    name: string | null;
-}
-declare const DateService: {
-    addMonths: (date: string, amount: number) => string;
-    getDaysInMonth: (date: string) => number;
-    getDayOfWeek: (date: string) => number;
-    getDays: () => DateItem[];
-    getMonths: () => DateItem[];
-    getQuickDates: () => StrictSimpleObject[];
-    getYears: (startYear?: number, endYear?: number) => DateItem[];
-    isToday: (date: string) => boolean;
-    subMonths: (date: string, amount: number) => string;
-};
-export default DateService;

package/dist/types/services/DownloadService.d.ts

@@ -1,5 +0,0 @@
-declare const _default: {
-    download: (alias: string) => void;
-    makeUrl: (alias: string) => string;
-};
-export default _default;

package/dist/types/services/FilterService.d.ts

@@ -1,13 +0,0 @@
-interface Query {
-    [key: string]: Query | Query[] | string[] | string;
-}
-export declare type FilterMap = Map<string, string[] | string>;
-export interface FilterOptions {
-    shouldFilterPage?: boolean;
-}
-declare const _default: {
-    getUrlForFilters: (data?: Query | undefined, includePathname?: boolean) => string;
-    makeUrl: (data: FilterMap, includePathname?: boolean) => string;
-    parseQuery: (query?: Query | undefined, options?: FilterOptions | undefined) => FilterMap;
-};
-export default _default;

package/dist/types/services/FormatService.d.ts

@@ -1,7 +0,0 @@
-declare const FormatService: {
-    date: (value?: unknown, formatString?: string) => string;
-    datetime: (value?: unknown) => string;
-    money: (value?: unknown) => string;
-    twoDigits: (value?: unknown) => string;
-};
-export default FormatService;

package/dist/types/services/OLD_ApiService.d.ts

@@ -1,19 +0,0 @@
-export interface ApiResponse<T> {
-    data: T;
-    headers: Headers;
-    ok: boolean;
-    originalResponse: Response;
-    redirected: boolean;
-    status: number;
-    statusText: string;
-    type: string;
-    url: string;
-}
-export interface ApiValidationErrorResponse {
-}
-declare const ApiService: {
-    get: <T>(url: string) => Promise<ApiResponse<T>>;
-    getErrorsFromResponse: (error: Error) => Record<string, string>;
-    request: <T_1 = Record<string, unknown>>(method: string, url: string) => Promise<ApiResponse<T_1>>;
-};
-export default ApiService;

package/dist/types/services/ToastService.d.ts

@@ -1,5 +0,0 @@
-declare const ToastService: {
-    success: (message: string) => void;
-    error: (message: string) => void;
-};
-export default ToastService;

package/dist/types/utility/MockRouter/index.d.ts

@@ -1,2 +0,0 @@
-import type { NextRouter } from 'next/router';
-export declare const createMockRouter: (pathname?: string | undefined, query?: Record<string, string> | undefined) => NextRouter;

package/dist/types/utility/StorybookPanel/index.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-interface StorybookPanelProps {
-    children: React.ReactNode;
-    isDeep?: boolean;
-}
-declare const StorybookPanel: React.FunctionComponent<StorybookPanelProps>;
-export default StorybookPanel;

package/dist/types/utility/TestChangeHandler/index.d.ts

@@ -1,15 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import type { InputValue } from '../interfaces';
-interface TestChangeHandlerProps<T> {
-    children: React.ReactNode;
-    defaultValue?: T;
-}
-declare const TestChangeHandler: {
-    <T extends InputValue>({ children, defaultValue, }: TestChangeHandlerProps<T>): React.ReactElement;
-    propTypes: {
-        children: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
-        defaultValue: PropTypes.Requireable<string | boolean | (string | boolean)[]>;
-    };
-};
-export default TestChangeHandler;

package/dist/types/utility/create-app.d.ts

@@ -1,4 +0,0 @@
-import type { AppType } from '../core/App';
-import type { Config } from '../hooks/useAppContext';
-declare const createApp: (config: Config) => AppType;
-export default createApp;

package/dist/types/utility/icons.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-export declare const AuthenticatorIcon: () => JSX.Element;
-export declare const YubikeyIcon: () => JSX.Element;

package/docs/guides/01-installation.story.mdx

@@ -1,33 +0,0 @@
-import { Meta } from '@storybook/addon-docs/blocks';
-
-<Meta title="Guides/Installation" />
-
-# Installation
-
-The easiest way to get started is to use Square Zero with the following command:
-
-```
-npx squarezero new example-project —template=admin
-```
-
-Square Zero is a command line tool for quickly generating React and Next.js projects of all shapes and sizes. [You can find out more about Square Zero here](https://sqrzro.com). Handily, it comes with a default template for Square Zero Admin.
-
-Running the above command will create a directory named ‘example-project’, and install a basic admin framework into it, including all dependencies.
-
-Now you’ll need to update the config file to define certain variables, such as the URL for your backend API, navigation links, general look and feel of the admin, and so on. [You can find a full list of configuration options here](/story/guides-configuration--page), and more [information specifically about the navigation options here](/story/guides-pages-routing--page). The config file is located at `src/config/index.js`. You will find some predefined values there. Feel free to edit those, and add others, to get the admin panel how you would like it.
-
-### A note about API paths
-
-As you can see from the config file, by default the API path is set to read from an ‘env.js’ file included in the root. This file is excluded from git, and allows you to define different backend URLs for the same admin panel in different environments. I.e. local, staging, and production versions can all point to different backend URLs.
-
-Now that your admin panel is installed and your config updated, you should be able to run the following in the root directory:
-
-```
-yarn start
-```
-
-This will start an instance of the admin system at http://localhost:8080, which you can visit in a browser. At the moment, there will simply be a login screen and a blank Dashboard page. For more information about [integrating your backend to enable authentication, click here](/story/guides-integration-with-api--page). If you’ve got that all set up and you’d like to start [adding your own pages, you can head over to here](/story/guides-pages-routing--page).
-
-## Manual Installation
-
-Although it is strongly advised that you install Square Zero Admin via the method above, there are potentially a few cases where you would want to install it manually. Full documentation for this is coming soon.

package/docs/guides/02-configuration.story.mdx

@@ -1,80 +0,0 @@
-import { Meta } from '@storybook/addon-docs/blocks';
-
-<Meta title="Guides/Configuration" />
-
-# Configuration
-
-The config file is located at `src/config/index.js`. Below is a full list of every configuration option available:
-
-## auth
-
-```jsx
-auth: {
-    identifier?: string;
-    identifierLabel?: string;
-    tfa?: boolean;
-} | null;
-```
-
-By default, the login form uses a field name of `username` for the identifier. However, there might be situations where you would want to use `email` or something else. In that instance, you can set `auth.identifier` (the field name) and `auth.identifierLabel` (the field label) to set an alternative.
-
-`tfa` (set to false by default) defines whether or not your backend API supports two-factor authentication.
-
-## Logo
-
-```jsx
-Logo: React.ComponentType | null;
-```
-
-If not null, `Logo` is a React component that returns an image. The logo sits on top of the colour defined in the `style.brand` configuration option.
-
-## name
-
-```jsx
-name: string;
-```
-
-The name of the site. This is the only config option that is required, and is used in the page titles.
-
-## navigation
-
-```
-navigation: (NavigationObject | string)[];
-```
-
-An array of items that will be in the primary navigation of the site. The item can either be a ‘-’, in which case a divider will be rendered, or a `NavigationObject` which is defined as:
-
-```
-NavigationObject {
-    label: string;
-    to?: string | null;
-    onClick?: MouseEventHandler<HTMLAnchorElement | HTMLButtonElement>;
-    permission?: string;
-}
-```
-
-Technically the only thing a `NavigationObject` requires is a `label`, which will be the text that is displayed on the link. The object will then need one of two things - a `to` value, which will point to the URL you would like the link to go, or a `onClick` value, which will define what function is triggered when the link is clicked. It is entirely possible to include both of these options.
-
-`permission` controls which admin user can or can’t see the particular object. Permissions are explained in more detail on the [API Integration page](/story/guides-integration-with-api--page).
-
-## paths
-
-```
-paths: { api?: string; app?: string };
-```
-
-The `paths.api` defines where your backend API is located. As you can see from the config file, by default the API path is set to read from an ‘env.js’ file included in the root. This file is excluded from git, and allows you to define different backend URLs for the same admin panel in different environments. I.e. local, staging, and production versions can all point to different backend URLs.
-
-The `paths.app` defines where your application itself is located, assuming it is not at the root of a domain. This can usually be omitted but if, for example, you would like your application to be hosted at https://example.com/admin/, you would define `paths.app` as `admin`. This would ensure all links and redirects within the app go to the right place.
-
-## style
-
-```
-style: { brand?: string; layout?: string } | null;
-```
-
-The `style.brand` value is simply a hexcode which defines the background colour for the logos throughout the site.
-
-`style.layout` can either be omitted, or be defined as ‘topbar’. If omitted, the layout of the application will appear in a traditional dashboard way - with the navigation running vertically along the left hand side of the page, and the content to the right. If, however, it is defined as ‘topbar’, the navigation runs horizontally across the top of the page.
-
-More style options may be added in future versions. However, it is an important tenet of Square Zero Admin that it does not offer too much customisation, in order to allow developers to focus on building pages rather than concerning themselves with style decisions.