真偽値

真偽値フィールド

真偽値(true/false)の入力用フィールドです。公開フラグ、注目記事フラグなど、オン/オフの切り替えに適しています。

基本例

{
	"name": "featured",
	"type": "boolean",
	"label": "注目記事"
}

プロパティ

プロパティ必須説明
namestringYesフィールドの識別子
type"boolean"Yes"boolean"を指定
labelstringNoCMS上での表示名
notestringNo編集者向けの補足メモ
requiredbooleanNo必須フィールドかどうか
defaultbooleanNoデフォルト値

使用例

注目記事フラグ

{
	"name": "featured",
	"type": "boolean",
	"label": "注目記事",
	"default": false
}

下書きフラグ

{
	"name": "isDraft",
	"type": "boolean",
	"label": "下書き",
	"default": true,
	"note": "チェックを外すと公開されます"
}

公開フラグ

{
	"name": "isPublished",
	"type": "boolean",
	"label": "公開する",
	"default": false
}

コメント許可

{
	"name": "allowComments",
	"type": "boolean",
	"label": "コメントを許可",
	"default": true
}

在庫あり

{
	"name": "inStock",
	"type": "boolean",
	"label": "在庫あり",
	"default": true
}

pit.draftとの関係

pit.draftで指定されたbooleanフィールドは、編集画面で特別な扱いを受けます。

{
	"fields": [
		{ "name": "title", "type": "text", "label": "タイトル" },
		{ "name": "isDraft", "type": "boolean", "label": "下書き", "default": true }
	],
	"pit": {
		"draft": "isDraft"
	}
}
  • 通常のフィールド一覧には表示されない
  • 保存ボタンの横にトグルスイッチとして表示される
  • 下書き状態の切り替えが直感的に行える

保存形式

真偽値はそのままboolean型として保存されます。

マークダウン形式:

---
featured: true
isDraft: false
---

JSON形式:

{
	"featured": true,
	"isDraft": false
}