Skip to content

docs(skills): gate the usePermissions example on can(), a boolean, and mark its fence (objectui#9671) #9994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
os-tesla wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −5
Draft

docs(skills): gate the usePermissions example on can(), a boolean, and mark its fence (objectui#9671) #9994

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions skills/objectui/guides/auth-permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,14 +221,20 @@ guide does not govern it; the two look alike and are unrelated.

### usePermissions hook

```typescript
<!-- os:check -->
```tsx
import { usePermissions } from '@object-ui/permissions';
import { Button } from '@object-ui/components';

function ContactActions({ contact }) {
const { check, checkField, getFieldPermissions, getRowFilter } = usePermissions();
function ContactActions({ contact }: { contact: { salary?: number } }) {
const { can, checkField, getFieldPermissions, getRowFilter } = usePermissions();

const canEdit = check('contacts', 'update', contact);
const canDelete = check('contacts', 'delete', contact);
// Gate on `can`, which answers a boolean. `check` answers `{ allowed, … }`, and
// an object is truthy, so gated on it both buttons render for a denied user
// too; its `record` argument reads no field of the record, so none is passed.
// `: boolean` is what makes a `check(...)` here fail to compile.
const canEdit: boolean = can('contacts', 'update');
const canDelete: boolean = can('contacts', 'delete');
const canSeeSalary = checkField('contacts', 'salary', 'read');

return (
Expand Down
Loading