mirror of
https://github.com/hanzo-apps/cms.git
synced 2026-10-30 14:47:33 +00:00
zeekay
09c5e16c5c
- payload -> @hanzo/cms (core), bin payload -> hanzo-cms - create-payload-app -> @hanzo/create-cms-app - @payloadcms/<x> -> @hanzo/cms-<x> across the whole dependency graph - 3545 files, 72 package.json, 4419 scoped refs, 3852 core import specifiers, 82 scss imports - MIT attribution to Payload CMS Inc. preserved (LICENSE.md, author emails) Upstream: github.com/payloadcms/payload @ v3.85.2 (MIT)
37 lines
1.5 KiB
Plaintext
37 lines
1.5 KiB
Plaintext
---
|
|
title: TypeScript - Overview
|
|
label: Overview
|
|
order: 10
|
|
desc: Payload is the most powerful TypeScript headless CMS available.
|
|
keywords: headless cms, typescript, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
|
|
---
|
|
|
|
Payload supports TypeScript natively, and not only that, the entirety of the CMS is built with TypeScript. To get started developing with Payload and TypeScript, you can use one of Payload's built-in boilerplates in one line via `@hanzo/create-cms-app`:
|
|
|
|
```
|
|
npx @hanzo/create-cms-app@latest
|
|
```
|
|
|
|
Pick a TypeScript project type to get started easily.
|
|
|
|
## Setting up from Scratch
|
|
|
|
It's also possible to set up a TypeScript project from scratch. We plan to write up a guide for exactly how—so keep an eye out for that, too.
|
|
|
|
## Using Payload's Exported Types
|
|
|
|
Payload exports a number of types that you may find useful while writing your own custom functionality like [Plugins](../plugins/overview), [Hooks](../hooks/overview), [Access Control](../access-control/overview) functions, [Custom Views](../custom-components/custom-views), [GraphQL queries / mutations](../graphql/overview) or anything else.
|
|
|
|
## Config Types
|
|
|
|
- [Base config](/docs/configuration/overview#typescript)
|
|
- [Collections](/docs/configuration/collections#typescript)
|
|
- [Globals](/docs/configuration/globals#typescript)
|
|
- [Fields](/docs/fields/overview#typescript)
|
|
|
|
## Hook Types
|
|
|
|
- [Collection hooks](/docs/hooks/collections#typescript)
|
|
- [Global hooks](/docs/hooks/globals#typescript)
|
|
- [Field hooks](/docs/hooks/fields#typescript)
|