payload/packages/plugin-multi-tenant/tsconfig.json at v3.22.0 - payload - Astzweig Git Server

tabshift/payload

Files

Jarrod Flesch e80d67987e feat(ui): exposes context of the view being rendered on the server (#10620 )

### What?
Extends visibility into what view is being shown so custom components
have context as to where they are being rendered.

**This PR does not add React Context.**

### Why?
This was needed for the multi-tenant plugin where the selector is in the
navigation sidebar and has no way to know if it is being shown inside of
a document or the list view.

I assume other users may also want their server components to be aware
of where a component is rendering before hitting the client. An example
would be wanting to redirect on the server instead of on the client,
this is how multi-tenant redirects users from "global" enabled
collections to the document view.

### How?
Adds 2 new variables that are determined by the view being routed to.

`viewType` - which view is being rendered, ie `list`, `document`,
`version`, `account`, `verify`, `reset`
```ts
type ViewTypes =
  | 'account'
  | 'dashboard'
  | 'document'
  | 'list'
  | 'reset'
  | 'verify'
  | 'version'
```

`documentSubViewType` - which tells you what sub view you are on, ie
`api`, `livePreview`, `default`, `versions`
```ts
type DocumentSubViewTypes =
  | 'api' 
  | 'default' 
  | 'livePreview' 
  | 'version' 
  | 'versions'
```

2025-01-16 15:44:09 -05:00

5 lines

108 B

JSON

Raw Permalink Blame History

 {
   "extends": "../../tsconfig.base.json",
   "references": [{ "path": "../payload" }, { "path": "../ui"}]
 }