Skip to content

Latest commit

 

History

History
223 lines (118 loc) · 4.42 KB

globals.md

File metadata and controls

223 lines (118 loc) · 4.42 KB
Raw

@globus/static-data-portal • Docs

@globus/static-data-portal

Type Aliases

Base

Base: object

The base type for a static.json file.

Type declaration

_static

_static: object

_static.generator

generator: object

_static.generator.name

name: string

The name of the generator used to build the static.json file. This should be a reference to the package name of the generator.

Example
"@globus/static-data-portal"
_static.host?

optional host: object

GitHub Action-injected environment variables.

See

https://github.com/from-static/actions

_static.host.base_path

base_path: string

_static.host.base_url

base_url: string

_static.host.host

host: string

_static.host.origin

origin: string

data

data: object

data.attributes

attributes: Record<string, unknown>

data.version

version: string

Defined in

utils/static.ts:9

Data

Data: object

The type used for data by the @globus/static-data-portal generator.

Type declaration

attributes

attributes: object

attributes.content

content: object

attributes.content.image?

optional image: string

The URL of the portal's header image.

attributes.content.navigation?

optional navigation: NavigationOptions

The navigation items for the portal.

attributes.content.privacy_policy?

optional privacy_policy: string

A privacy policy to be rendered at /privacy-policy. This is especially useful for associating the published URL with your registered Globus Auth application.

attributes.content.subtitle?

optional subtitle: string

The subtitle of the research data portal.

attributes.content.tagline?

optional tagline: string

Deprecated

tagline will be removed in a future release. For customization of the homepage, use a index.mdx file.

attributes.content.terms_of_service?

optional terms_of_service: string

Terms and conditions to be rendered at /terms-and-conditions. This is especially useful for associating the published URL with your registered Globus Auth application.

attributes.content.title

title: string

The title of the research data portal.

attributes.globus

globus: object

attributes.globus.application

application: object

Information about your registered Globus Auth Application (Client)

See

https://docs.globus.org/api/auth/developer-guide/#developing-apps

attributes.globus.application.client_id

client_id: string

The UUID of the client application.

attributes.globus.application.redirect_uri?

optional redirect_uri: string

The redirect URI for the Globus Auth login page to complete the OAuth2 flow. The portal will make a reasonable effort to determine this URI, but this field is provided as a fallback. To use the portal's built-in authorization handling, redirects should be sent to /authenticate on the host.

Example
"https://example.com/data-portal/authenticate"
attributes.globus.transfer

transfer: TransferCollectionConfiguration | object

Configuration for Transfer-related functionality in the portal.

attributes.theme?

optional theme: ThemeSettings

version

version: string

The version of the data object, which is used to determine how the generator will render its attributes.

Example
"1.0.0"

Defined in

utils/static.ts:39

Static

Static: Base & object

Type declaration

data

data: Data

Defined in

utils/static.ts:115

Modules