Skip to content

add docs for chip widget #631

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add docs for chip widget #631

wants to merge 2 commits into from

Conversation

tabacitu
Copy link
Member

@tabacitu tabacitu commented Jun 21, 2025

This PR adds docs for the chip widget introduced in Laravel-Backpack/CRUD#5815 and with demo examples in Laravel-Backpack/demo#701

Documented:

  • what is a chip
  • how to use the crud::chips.general chip
  • how to use chips as widgets
  • how to use chips as columns
  • how to use chips outside CrudControllers
  • how to create your own chip

Todo:

  • add images
  • polish text & layout

@tabacitu tabacitu self-assigned this Jun 21, 2025
@tabacitu tabacitu moved this to In Review in Backpack v7.0 Jun 21, 2025
@tabacitu tabacitu moved this to Needs Testing, Review or Docs in This week Jun 21, 2025
@tabacitu
Copy link
Member Author

While trying to document this feature, I've realised that... it's difficult to document it, because it's unlike any other features we have:

  • it's not a Component, so we can't add it to Components
  • it's not a standard CRUD feature, so we can't document it in fields or columns

Currently I think we have the following options:

  • (A) we can turn it into a Component - and maybe call it Datachip; but realistically the PHP Class won't do anything; and I do NOT want this to take its info from a controller, that is overkill and would make it more difficult to customize than I intend it to;
  • (B) we can keep it a Blade view - and document it in a separate page under the Show & List operations; we basically create a new TYPE of blade file (chips), which comes with one built-in file... and a way to create your own;

From the above... I think I like Option B best. So I'm going to do that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Review
Status: Needs Testing, Review or Docs
Development

Successfully merging this pull request may close these issues.

1 participant