From 61a7dd65f1eb1e0d45e3cbfe2968a31aca9c2c68 Mon Sep 17 00:00:00 2001 From: Gildas Garcia <1122076+djhi@users.noreply.github.com> Date: Wed, 3 May 2023 15:24:10 +0200 Subject: [PATCH] Remove doc from BooleanField --- docs/BooleanField.md | 30 ------------------------------ 1 file changed, 30 deletions(-) diff --git a/docs/BooleanField.md b/docs/BooleanField.md index 4ae3e6a3f03..62f66d10b29 100644 --- a/docs/BooleanField.md +++ b/docs/BooleanField.md @@ -67,33 +67,3 @@ import AlarmOnIcon from '@mui/icons-material/AlarmOn'; ``` - -## TypeScript - -The `` component accept a generic type that describe the record. This is used to validate the `source` prop to ensure it targets an actual property of the record: - -```tsx -import * as React from "react"; -import { Show, SimpleShowLayout, TextField, BooleanField, RichTextField } from 'react-admin'; - -type Post = { - id: number; - title: string; - teaser: string; - body: string; - published: boolean; -} - -export const PostShow = () => ( - - - source="title" /> - source="teaser" /> - source="body" /> - source="published" /> - - -); -``` - -Specifying the record type will also allow your IDE to provide auto-completion for both the `source` and `sortBy` prop. Note that the `sortBy` prop also accept any string.