Skip to content

Add a step-by-step table setup guide - #72

Open
yZangEren wants to merge 2 commits into
jlord:masterfrom
yZangEren:add-step-by-step-table-docs
Open

yZangEren wants to merge 2 commits into
jlord:masterfrom
yZangEren:add-step-by-step-table-docs

Conversation

@yZangEren

@yZangEren yZangEren commented Jun 3, 2026 •

Copy link
Copy Markdown

Fixes #24.

Summary

  • add a step-by-step setup guide for creating a searchable, sortable, paginated table
  • fix the README example so the template id matches the templateID option
  • fix the clear link examples to use class="clear"
  • clarify how sortable header text maps to data keys
  • replace the stale hosted demo link with a local npm run bfy + test/index.html demo path
  • make the local browserify/test data helpers lint-clean so the demo path has a clean validation story

Testing

  • npm.cmd run bfy
  • npm.cmd run lint
  • git diff --check
  • Browser smoke test against http://127.0.0.1:8765/index.html: table rendered, pagination appeared, and typing Dog filtered the table to the two Dog rows. The only console error was the browser's automatic favicon.ico 404 from the temporary local server.

This is focused on the broken/missing manual called out in the issue and on making the existing copy-paste example and local demo work as written.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Step-by-step manual? Demo examples don't work

1 participant