Skip to content

Commit 864712b

Browse files
committed
update Show props
1 parent 452f358 commit 864712b

File tree

1 file changed

+6
-34
lines changed
  • docs/reference/components/control

1 file changed

+6
-34
lines changed

docs/reference/components/control/show.mdx

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,50 +1099,22 @@ The following example uses `<Show>`'s `when` prop with a callback function to co
10991099
## Properties
11001100

11011101
<Properties>
1102-
- `condition?`
1103-
- `has => boolean`
1104-
1105-
Optional conditional logic that renders the children if it returns `true`.
1106-
1107-
---
1108-
11091102
- `fallback?`
11101103
- `JSX`
11111104

11121105
Optional UI to show when a user doesn't have the correct type of access control to access the protected content.
11131106

11141107
---
11151108

1116-
- `feature?`
1117-
- `string`
1118-
1119-
Optional string corresponding to a [Feature](/docs/guides/billing/overview).
1120-
1121-
---
1122-
1123-
- `plan?`
1124-
- `string`
1125-
1126-
Optional string corresponding to a [Plan](/docs/guides/billing/overview).
1127-
1128-
---
1129-
1130-
- `permission?`
1131-
- `string`
1132-
1133-
Optional string corresponding to a [Permission](/docs/guides/organizations/control-access/roles-and-permissions) in the format `org:<feature>:<permission>`
1134-
1135-
---
1136-
1137-
- `role?`
1138-
- `string`
1109+
- `treatPendingAsSignedOut?`
1110+
- `boolean`
11391111

1140-
Optional string corresponding to a [Role](/docs/guides/organizations/control-access/roles-and-permissions) in the format `org:<role>`
1112+
A boolean that indicates whether to treat [pending sessions](/docs/reference/javascript/types/session-status#properties) as signed out. Defaults to `true`.
11411113

11421114
---
11431115

1144-
- `treatPendingAsSignedOut?`
1145-
- `boolean`
1116+
- `when`
1117+
- `'signed-in' | { feature: string } | { permission: string } | { plan: string } | { role: string } | (has) => boolean`
11461118

1147-
A boolean that indicates whether to treat [pending sessions](/docs/reference/javascript/types/session-status#properties) as signed out. Defaults to `true`.
1119+
Determines when to render the children. Can be `'signed-in'` for authentication checks, an object with a [Feature](/docs/guides/billing/overview), [Permission](/docs/guides/organizations/control-access/roles-and-permissions), [Plan](/docs/guides/billing/overview), or [Role](/docs/guides/organizations/control-access/roles-and-permissions) for authorization checks, or a callback function for custom conditional logic.
11481120
</Properties>

0 commit comments

Comments
 (0)