TableCrafter Documentation

Everything you need to turn Google Sheets, APIs, JSON and CSV into fast, accessible, mobile-first WordPress tables.

Getting Started

Core Concepts

Data Sources

Data Sources Overview
Compare every TableCrafter data source: remote JSON APIs, local JSON/CSV files, Google Sheets, and Airtable. Learn which source type to use and when.
Connect Google Sheets
Display a published Google Sheet as a live WordPress table with TableCrafter. Paste the sheet link, pick a tab with gid, and configure auto-refresh.
Private & API-Key Google Sheets
Connect Google Sheets to TableCrafter via the public CSV export and gviz endpoints. How link-sharing, the key-in-URL model, and SSRF protection really work.
Connect a REST API or JSON Endpoint
Connect TableCrafter to any REST API or JSON endpoint: map nested responses to rows and columns, send auth headers, and stay protected by built-in SSRF defenses.
REST API Authentication
How TableCrafter authenticates REST/JSON data sources: Bearer tokens for Airtable, query-string API keys, encrypted token storage, and SSRF-safe fetching.
Working with Nested JSON
Point TableCrafter at nested JSON with the root attribute, flatten objects and arrays into table columns, and fix common path errors.
Connect a JSON File or URL
Connect any JSON file or API URL to TableCrafter, drill into nested arrays with the root path attribute, and rename columns with include aliasing.
Connect a CSV File
Connect a hosted or uploaded CSV file to TableCrafter. Learn the source URL format, header-row and delimiter behavior, and a working [tablecrafter] example.
Mapping Fields to Columns
Choose which TableCrafter data fields become table columns, set their order, and relabel headers using the include, exclude, and root shortcode attributes.
Auto-Refresh & Live Data
Keep TableCrafter tables live with SWR caching, configurable auto-refresh intervals, smart interaction pausing, visual indicators, and data-source health monitoring.
Data Source Troubleshooting
Fix TableCrafter data source errors: unreachable or blocked URLs, SSRF blocks, CORS, Airtable auth failures, invalid JSON, and empty or malformed data.

Integration Methods

Table Features

Live Search & Sorting
Add a live search box and clickable multi-column sorting to TableCrafter tables. Learn the search attribute, server-side sort, and accessibility behavior.
Filtering Data
Filter TableCrafter tables with global search and auto-detected per-column filters (text, multi-select, date range, number range). Real attributes and CSS only.
Pagination
Add client-side pagination to TableCrafter tables with the per_page attribute. Set page size, handle large datasets, and use auto-optimization for 1,000+ rows.
Column Management
Control which columns appear in TableCrafter tables: include/exclude keys, set column order, and rename headers with the include attribute's alias syntax.
Column Formatting
How TableCrafter auto-formats cell values — links, emails, images, dates, booleans and tags — plus the real CSS classes you override to restyle them.
Responsive Design & Touch Gestures
TableCrafter's mobile-first card layout, 768/900/1200 breakpoints, swipe-right to expand, swipe-left for actions, 44px touch targets, and 60fps interactions.
Accessibility (WCAG 2.1 AA)
TableCrafter is WCAG 2.1 AA compliant out of the box: 44px touch targets, ARIA labels, screen reader announcements, keyboard navigation, and high contrast.
Custom Styling & CSS Variables
Theme TableCrafter tables with .tc- CSS classes, target columns by data-field, and use the high-contrast and reduced-motion CSS variables and modes.
Dark Mode & Theming
How TableCrafter handles dark mode, high-contrast CSS variables, and reduced motion, plus how to theme a full dark table by overriding real .tc- classes.
Loading & Empty States
How TableCrafter renders loading skeletons, empty-table messages, and error states for the [tablecrafter] shortcode, plus the CSS classes and JS hooks you can style.

Data Export

Developer Reference

Shortcode Parameter Reference
Complete reference for the [tablecrafter] shortcode: every supported attribute with its type, default, and behavior, plus real examples and admin paths.
Hooks & Filters
TableCrafter developer reference for PHP filters (tc_export_templates, trusted IP headers) and frontend JavaScript CustomEvents with full signatures and examples.
JavaScript Events & API
Hook into TableCrafter's frontend JavaScript: the tablecrafter:cardTap/cardView/cardEdit DOM events, auto-init flow, and public instance methods like setData, refreshNow, and destroy.
CSS Classes Reference
Reference for the real CSS class names TableCrafter emits on tables, cards, controls, and state, plus the CSS variables exposed for theming and styling.
Markup & Template Structure
How TableCrafter outputs HTML: the [tablecrafter] container, server-rendered table markup, JS-built toolbar/pagination, CSS classes, and theming hooks.
Security: SSRF Protection & Capabilities
How TableCrafter protects remote fetches with SSRF guards, WordPress capability checks, nonce verification, rate limiting, and output escaping against XSS.
Caching & Performance Internals
How TableCrafter delivers sub-100ms tables with SWR transient caching, server-side rendering for SEO, zero-latency hydration, and a zero database footprint.
Performance Tuning
Tune TableCrafter for large datasets: pagination thresholds, virtual scrolling, SWR cache lifetime, and auto-refresh interval trade-offs with real shortcode attributes.
Extending: Custom Data Sources
How developers extend TableCrafter data sources: the URL-protocol source pattern, real WordPress filters, the cache-refresh cron action, JS events, and CSS theming.

Recipes

Troubleshooting & FAQ

Pro

Migration