checklist > checkbox group

[Sebastian-ubs]

Rename checklist component to checkbox group to avoid confusion with the checklist feature of Paratext.

• Deprecate name of checklist component
• Align naming checkbox group with shadcn

---

This change is 

[tjcouch-sil]

@tjcouch-sil reviewed 1 file and made 1 comment.
Reviewable status: 1 of 9 files reviewed, 1 unresolved discussion (waiting on Sebastian-ubs).

---

lib/platform-bible-react/src/components/basics/checkbox-list.component.tsx line 42 at r1 (raw file):

/** Renders a list of checkboxes. Each checkbox corresponds to an item from the `listItems` array. */
export function CheckboxList({

Unfortunately we can't just rely on not knowing of extensions that use it in my opinion. This is such a generic component and was created so long ago (2 years) that it's really hard to know if it actually isn't used anywhere in the world. I suggest you re-export this and the props as the original names with deprecated statements in their TSDocs so we don't duplicate the code but we're still notifying that we want to get rid of the old component. Something like one of these solutions will hopefully let you add different TSDocs.

[tjcouch-sil]

@tjcouch-sil partially reviewed 1 file.
Reviewable status: 2 of 9 files reviewed, 1 unresolved discussion (waiting on Sebastian-ubs).

[tjcouch-sil]

@tjcouch-sil reviewed 1 file.
Reviewable status: 3 of 9 files reviewed, 1 unresolved discussion (waiting on Sebastian-ubs).

[Sebastian-ubs]

Instead we should use Checkbox group https://ui.shadcn.com/docs/components/radix/checkbox#group

[Sebastian-ubs]

Rebased onto latest main and addressed review feedback:

• Renamed the shared component to CheckboxGroup (file, props, stories, exports, and the select-books-dialog consumer).
• Per @tjcouch-sil's feedback, kept Checklist and ChecklistProps as @deprecated backward-compatible re-exports (aliasing CheckboxGroup/CheckboxGroupProps) so existing external consumers keep working while signaling the migration.
• Fixed outdated Tailwind tw- → tw: prefixes in the stories (non-functional under Tailwind 4) and rebuilt the platform-bible-react dist bundle.

Note: branch was force-pushed (rebased onto current main, dropping the redundant shadcn-upgrade commit already in main as #2207). Ready for another look. 🙏

[Sebastian-ubs]

sorry, was trying to add the icon to the title like in #2267 but that's not needed. so ready for review now

[Sebastian-ubs]

now really ready for human review

[tjcouch-sil]

Nice! Thanks for the updates. Just one last thing to look at

@tjcouch-sil partially reviewed 10 files and all commit messages, made 3 comments, and resolved 1 discussion.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on Sebastian-ubs).

---

lib/platform-bible-react/src/components/basics/checkbox-list.component.tsx line 42 at r1 (raw file):

Previously, tjcouch-sil (TJ Couch) wrote…

Unfortunately we can't just rely on not knowing of extensions that use it in my opinion. This is such a generic component and was created so long ago (2 years) that it's really hard to know if it actually isn't used anywhere in the world. I suggest you re-export this and the props as the original names with deprecated statements in their TSDocs so we don't duplicate the code but we're still notifying that we want to get rid of the old component. Something like one of these solutions will hopefully let you add different TSDocs.

Thanks!

---

lib/platform-bible-react/src/index.ts line 167 at r6 (raw file):

export type { ChapterRangeSelectorProps } from './components/basics/chapter-range-selector.component';
export {
  /** @deprecated Use {@link CheckboxGroup} instead. */

Please put the date of deprecation here and in the checkbox group file

[tjcouch-sil]

Yay! Thanks!

[Sebastian-ubs]

@Sebastian-ubs made 1 comment.
Reviewable status: 3 of 10 files reviewed, 1 unresolved discussion (waiting on tjcouch-sil).

---

lib/platform-bible-react/src/index.ts line 167 at r6 (raw file):

Previously, tjcouch-sil (TJ Couch) wrote…

Please put the date of deprecation here and in the checkbox group file

Done.