Skip to content

Latest commit

 

History

History
189 lines (105 loc) · 3.83 KB

-internal-.md

File metadata and controls

189 lines (105 loc) · 3.83 KB
Raw

@globus/static-data-portal • Docs

<internal>

Type Aliases

ColorDefinition

ColorDefinition: object | string

Defined in

theme.ts:9

NavigationItem

NavigationItem: object | object

Defined in

components/Navigation.tsx:21

NavigationOptions

NavigationOptions: object

Type declaration

items

items: NavigationItem[]

Defined in

components/Navigation.tsx:33

Parameters<T>

Parameters<T>: T extends (...args) => any ? P : never

Obtain the parameters of a function type in a tuple

Type Parameters

• T extends (...args) => any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1633

Record<K, T>

Record<K, T>: { [P in K]: T }

Construct a type with a set of properties K of type T

Type Parameters

• K extends keyof any

• T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1606

ThemeSettings

ThemeSettings: object

Type declaration

colorScheme?

optional colorScheme: string

Apply a default color scheme to all components. This supports all Chakra UI color schemes and is not provided by default.

See

https://v2.chakra-ui.com/docs/styled-system/theme#colors for available color schemes.

colors?

optional colors: Record<string, ColorDefinition>

Specific color definitions to use in the theme. The most common use case is to define a primary color.

Example
{
  "colors": {
    "primary": {
     "50": "#E5F2FF",
     "100": "#B8DBFF",
     "200": "#8AC4FF",
     "300": "#5CADFF",
     "400": "#2E96FF",
     "500": "#007FFF",
     "600": "#0066CC",
     "700": "#004C99",
     "800": "#00264c",
     "900": "#001933"
  }
 }
}
See

https://v2.chakra-ui.com/docs/styled-system/theme#colors

extendTheme?

optional extendTheme: Parameters<typeof extendTheme>[0]

Extend the Chakra UI theme.

See

https://v2.chakra-ui.com/docs/styled-system/customize-theme#using-theme-extensions

Defined in

theme.ts:24

TransferCollectionConfiguration

TransferCollectionConfiguration: object

Type declaration

collection_id

collection_id: string

The UUID of the Globus collection to list and transfer files from.

label?

optional label: string

A human-readable label for the Source Selector. If not provided, the Collection's display_name (and path) will be used.

path?

optional path: string

The path on the collection to list and transfer files from.

Defined in

pages/transfer.tsx:45

Functions

extendTheme()

extendTheme(...extensions): Record<string, any>

Parameters

• ...extensions: (Record<string, any> | (theme) => Record<string, any>)[]

Returns

Record<string, any>

Defined in

node_modules/@chakra-ui/theme-utils/dist/extend-theme.d.ts:19