Skip to content

Fix CheckboxListField skill template: use CheckboxListFieldProps and array form state #5324

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

Merged
manuelblum merged 2 commits into from
Mar 16, 2026
Merged

Fix CheckboxListField skill template: use CheckboxListFieldProps and array form state #5324

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65c7575
Initial plan
Copilot Mar 16, 2026
2d3a3d7
cms-admin: fix CheckboxListField template to use CheckboxListFieldPro…
Copilot Mar 16, 2026
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
14 changes: 6 additions & 8 deletions ...-skills/comet-admin-translatable-enum/references/enum-06-checkbox-list-field.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,16 @@ Multi-select enum field. Form state is an array.

## Template

Same shape as SelectField, swap `SelectField` → `CheckboxListField`:

```tsx
import { CheckboxListField, type SelectFieldProps } from "@comet/admin";
import { CheckboxListField, type CheckboxListFieldProps } from "@comet/admin";
import { {camelCaseName}FormattedMessageMap } from "{enumImportPath}";
import { recordToOptions } from "@src/common/components/enums/recordToOptions";
import { type GQL{EnumName} } from "@src/graphql.generated";
import { type FunctionComponent } from "react";

export type {EnumName}FormState = GQL{EnumName};
export type {EnumName}FormState = GQL{EnumName}[];

type {EnumName}CheckboxListFieldProps = Omit<SelectFieldProps<{EnumName}FormState>, "options">;
type {EnumName}CheckboxListFieldProps = Omit<CheckboxListFieldProps<GQL{EnumName}>, "options">;

export const {EnumName}CheckboxListField: FunctionComponent<{EnumName}CheckboxListFieldProps> = ({ name, ...restProps }) => {
return <CheckboxListField name={name} {...restProps} options={recordToOptions({camelCaseName}FormattedMessageMap)} />;
Expand All @@ -38,15 +36,15 @@ export const {EnumName}CheckboxListField: FunctionComponent<{EnumName}CheckboxLi
```tsx
// File: admin/src/location/components/locationStatusCheckboxListField/LocationStatusCheckboxListField.tsx

import { CheckboxListField, type SelectFieldProps } from "@comet/admin";
import { CheckboxListField, type CheckboxListFieldProps } from "@comet/admin";
import { locationStatusFormattedMessageMap } from "@src/common/components/enums/locationStatus/locationStatus/LocationStatus";
import { recordToOptions } from "@src/common/components/enums/recordToOptions";
import { type GQLLocationStatus } from "@src/graphql.generated";
import { type FunctionComponent } from "react";

export type LocationStatusFormState = GQLLocationStatus;
export type LocationStatusFormState = GQLLocationStatus[];

type LocationStatusCheckboxListFieldProps = Omit<SelectFieldProps<LocationStatusFormState>, "options">;
type LocationStatusCheckboxListFieldProps = Omit<CheckboxListFieldProps<GQLLocationStatus>, "options">;

export const LocationStatusCheckboxListField: FunctionComponent<LocationStatusCheckboxListFieldProps> = ({ name, ...restProps }) => {
return <CheckboxListField name={name} {...restProps} options={recordToOptions(locationStatusFormattedMessageMap)} />;
Expand Down
Loading