Component Guide
Components are the building blocks of every page you design — dashboards, reports, forms, portals and marketing pages. Drag one from the palette onto the canvas, then shape it in the Properties panel on the right. This guide is a quick tour of what each component is for and what it can do.
SELECT, and they fill in at run time.Contents
- The data-binding model (read this once)
- Dashboard & analytics widgets
- Data & reports
- Filters & navigation
- Content & media
- Forms & input
- Layout & structure
- Feedback & status
- Marketing sections
The data-binding model — read this once
Almost every data component shares the same three ideas, so once you know them you know them all:
- Two data sources. Pick a table + columns (with an optional aggregate,
WHERE, order and row cap), or write a customSELECTfor anything more (grouping, joins, calculations). Write SQL in MySQL — it is auto-translated to PostgreSQL, SQL Server or SQLite. - Security is automatic. Table-bound components respect Row-Level Security, so each viewer only sees rows they’re allowed to.
- Custom SQL is read-only. A component’s own SQL must be one
SELECT(aWITH … SELECTis fine). Anything that could change or export data is refused — and the canvas tells you so instead of showing a silent zero:
✔SELECT status, COUNT(*) FROM tasks WHERE owner_id = :userid GROUP BY status
✔WITH open AS (SELECT * FROM tasks WHERE status <> 'Done') SELECT COUNT(*) FROM open
✖UPDATE tasks SET …· ✖SELECT 1; DELETE FROM tasks· ✖SELECT … INTO OUTFILE …
Custom SQL is not narrowed by Row-Level Security automatically — add:userid(or another SQL variable) where each viewer should see only their own rows. - They react to filters. Reference a Page Filter or
Date Range Filter with
:get.year,:get.frometc. in aWHERE, and the component re-queries when the filter changes — the foundation of a live dashboard. - You see real numbers while you design. KPI tiles, Charts, KPI rows, Gauges and Bar Lists show
your actual data right on the canvas (marked Live), whether they read a table or your own
SELECT. Filters with:today,:useridand other SQL variables preview exactly as they will run in the built app. - Cards that line up. Gauge, Bar List, Funnel and Heatmap have a Card frame option (on for new widgets) so they sit on the same surface as KPI tiles and charts — and cards placed side by side share the row’s height. Example: a doughnut, a “Tasks per person” bar list and a % done gauge at ⅓ width each make one even row.
Dashboard & analytics widgets
| Component | What it’s for & possibilities |
|---|---|
| Table Card | A report card wrapping an auto-generated table — a “Top 10”, a recent list, a grouped summary. Styleable header/footer, colour presets, and a totals row (SUM/COUNT/AVG…). |
| Gauge | A speedometer or ring for one metric vs a target/max — utilization, score, goal %. Colour it red/amber/green by threshold. |
| Live Value NEW | A reactive value for Add/Edit forms — hidden until a condition on the form is met, then it instantly fetches a calculated number from the database over AJAX and shows it (e.g. pick a Customer → see their outstanding Due Amount). Watches other form fields and recomputes as they change; the WHERE reads them via :field.<name> (plus :userid, :today, :get.x…). Aggregate or custom SELECT, currency formatting, and a threshold colour (e.g. red when due > 0). Row-Level Security is applied. Also great for stock-on-hand, credit remaining, last order date, live counts — or a whole multi-metric snapshot panel (Due + Credit + Last order in one card). |
| Bar List | A ranked breakdown — labelled rows with proportional bars. The go-to for “Top N by value” (sales by region, schools by books). Optional % of total. |
| Funnel | Conversion stages with decreasing bars and drop-off % — visitors → signups → trials → paid. |
| Heatmap | A GitHub-style calendar grid — one cell per day, shaded by how much happened. Great for activity and engagement over months. |
| KPI Stat / Stat Card / KPI Row | Big single numbers with a label and icon — the headline metrics that sit across the top of a dashboard. |
| KPI Trend Card | A metric with a period-over-period delta (▲ green / ▼ red) — “Revenue $48k ▲12%”. Manual or live from SQL. |
| Progress Card | A labelled progress bar toward a goal or quota. |
| Chart | Line, bar, column, area, pie or donut — bound to a table or query. The workhorse for trends and comparisons. |
| Mini Table | A compact few-column table for a dashboard corner — lighter than a Table Card. |
| Recent Activity / Notifications / Task List | Live feeds of the latest records, alerts or to-dos. |
| Calendar / Timeline | Month grid or chronological list of records by date. |
| Menu Card / Menu Group / Quick Links | Landing-page tiles and link groups that route into your app’s tables and pages. |
| Welcome Hero | A greeting banner (“Good morning, {name}”) for the top of a dashboard. |
Data & reports
| Component | What it’s for & possibilities |
|---|---|
| Pivot Table | A cross-tab report — rows × columns × a measure (product × month × SUM(total)) with row, column and grand totals. Top-N rows/columns with an “Others” roll-up keeps wide data tidy; a colour scale (heatmap) highlights hotspots; show cells as raw values or % of row / column / grand total. |
| Detail Grid / Master Detail | Full data grids and parent→children layouts — the record-management surfaces of your app. |
| Summary / Totals | Aggregated figures and totals rows for a report footer. |
| Card Gallery | Records as a responsive grid of cards instead of a table. |
| Table Toolbar / Selection Bar | The list-page action bar (add, search, export) and the bulk-selection bar. |
| Letterhead NEW | The company header for Document pages (invoice, ledger, statement…) — logo, company name, tagline, address, phone/email/website and a Tax ID line (PAN/VAT), pre-filled from your app’s Style brand. Upload / Pick your logo right in the property panel (stored in Custom Files, embedded sharply in PDFs). Four layouts (logo left/right, centred, stacked), accent colour and a rule beneath. Renders identically on screen, in print and in the server PDF. |
| Line Items + Totals NEW | The document-grade items table — Serial / Description / Qty / Unit / Rate / Amount from a detail table (WHERE … = :master.id, Row-Level Security applied) or a custom SELECT, then Subtotal → Discount (% or fixed) → Tax/VAT % → Round-off → Grand total and the amount in words in English, Indian/Nepali lakh-crore style or Nepali (Devanagari). Switch off Rate/Amount for a delivery note. |
| Page Break NEW | Forces the following components onto a new page — on paper, in the browser PDF and in the server PDF. Invisible when printed; a dashed marker while designing. |
| QR Code UPDATED | A QR code generated on your own server (no third-party service, works offline, prints and renders inside PDFs). Encode a URL, text, e-mail, phone or SMS; on Document pages the value accepts :master.field / {{field}} tokens — e.g. a payment link per invoice. Colours, quiet zone, frame and caption. |
| Signature NEW | Authorised-signatory block for documents — signature image and stamp/seal (Upload / Pick), signature line, name, title, label and an optional English or Nepali date. Tokens sign each record with its own approver. |
| Barcode NEW | Code 128 barcode generated on your server (crisp SVG, scannable) — INV-{{invoice_no}} per record for file copies, labels and dispatch notes. |
| Document Generator / Format Selector | Produce and export documents (PDF/Word/Excel) from records. |
| AI Assistant | An in-page assistant that can read and summarise your data (where enabled). |
Filters & navigation
| Component | What it’s for & possibilities |
|---|---|
| Page Filter | One dropdown that drives the whole page — pick a value (an academic year, a branch) and every data component re-queries for it. Instant AJAX refresh. |
| Date Range Filter | From/to picker with presets (Today, Last 7 days, This month…) driving ?from=&to= — the reporting companion to Page Filter. |
| Filter Panel / Advanced Search / Filter Chips / Filter Tabs | The list-page filtering toolkit — a filter drawer, a search builder, active-filter chips, and quick tab filters. |
| Breadcrumb / Toolbar / Pagination / Page Size | Standard navigation chrome for list and record pages. |
| Button / Button Group / Workflow Steps | Actions and multi-step progress indicators. See also Custom Button for a JS→PHP→JS action. |
| External Link / Download Link | Links out of the app and file downloads. |
Content & media
Heading, Text, Image, Icon, Clock, Video, Iframe, Alert, Divider — the everyday building blocks. HTML / Code / PHP / JS / CSS Snippet drop in custom markup or code when you need an escape hatch. Print Header / Print Footer / Print Panel shape printed and PDF output.
Forms & input
Field, Form, Field Group, Buttons assemble data-entry forms (the Add/Edit pages are built from these). Upload handles files and images, Radio Group and Field Selector offer choices, and validation and default values are configured per field.
Layout & structure
Section, Layout Row, Cell Grid, Card, Column, Cell arrange everything on a responsive grid. Tabs, Accordion, Modal, Offcanvas, Group Container organise content into panels, drawers and dialogs. Every component has per-device visibility and a phone position (Show first / Show last), so one page can show a full grid on desktop and a compact list on mobile with the important part on top.
Feedback & status
Status Badge, Toast, Progress, Rating, Avatar, Signature, QR Code, Wizard Step — small elements that show state, capture a signature or rating, and guide a user through a process.
Marketing sections
A full set of landing-page blocks for public pages: Navbar, Hero, Feature Grid, Feature Split, Bento Grid, Pricing, Testimonials, Team, FAQ, Logo Cloud, Stats, CTA Band, Contact Form, Newsletter, Footer, plus Carousel, Gallery, Countdown, Marquee, Social Links, Announcement Bar, Cookie Consent, Back to Top and more. Several are data-bound (Stats, Logo Cloud, Post Grid) so they can pull live figures and records. To keep bots out of a public form, drop in the CAPTCHA block (self-hosted, no third-party keys) or switch on Contact Form’s Require CAPTCHA. To take money, add the Payment button (Stripe, PayPal, Razorpay, Khalti, eSewa, Fonepay, or a built-in Test simulator) — the amount is server-fixed and every payment is recorded automatically. To take appointments, add the Booking widget — set your working hours and slot length and visitors pick a free time; the server prevents double-booking and records every appointment. For recurring revenue, the Subscription component builds a pricing table of plans (Stripe, PayPal or Razorpay) with trials, auto-seeded plan tables, subscriber tracking, and webhook-driven renewals + cancellation.