QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 60e5a80ed7a5a67877bfb3e129b1929c83464b6e] (pull_request) Successful in 11s
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 9s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
Shared Java Maven CI / secrets (push) Successful in 37s
QRun-IO/ci-policy: Shared Java Maven CI / secrets (pull_request) Successful in 38s
Shared Java Maven CI / gate (push) Canceled after 0s
Shared Java Maven CI / verify (push) Canceled after 0s
qrun-release / release (push) Canceled after 4m51s
qrun-release / postpublish (push) Canceled after 0s
QRun-IO/ci-policy: Shared Java Maven CI / verify (pull_request) Successful in 58s
QRun-IO/ci-policy: Shared Java Maven CI / gate (pull_request) Successful in 27s
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Successful in 42m42s
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 13s
Release candidate / release-rc (pull_request) Skipped
Import qqq-bom-pom 4.1.0-RC.21 unconditionally ahead of the parent's BOM and remove the opt-in qqq-snapshot profile and its Sonatype snapshot repository. State the minimum QQQ version as 4.1.0+ in the README. The development revision and the parent are unchanged. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
165 lines
4.7 KiB
Markdown
165 lines
4.7 KiB
Markdown
# QBit: Customizable Table Views
|
|
[](https://circleci.com/gh/Kingsrook/qbit-customizable-table-views)
|
|
[](https://central.sonatype.com/namespace/com.kingsrook.qbits)
|
|
[](https://adoptium.net/)
|
|
[](LICENSE.txt)
|
|
|
|
**QBit Customizable Table Views** provides table personalization capabilities for QQQ applications, allowing users to customize which fields and widgets they see based on their roles and permissions.
|
|
|
|
## 🚀 What Makes This QBit Different?
|
|
|
|
**Role-Based Table Customization** - This QBit enables fine-grained control over table presentation without modifying application code. Users see different fields and widgets based on their assigned roles, providing a personalized experience while maintaining security and data integrity.
|
|
|
|
## 🔓 Open Source & Full Control
|
|
|
|
**This QBit is 100% open source** - you have complete ownership and control:
|
|
|
|
User-defined saved views for QQQ dashboard tables.
|
|
|
|
**For:** QQQ developers who want users to save and share custom table configurations
|
|
**Status:** Stable
|
|
|
|
## Why This Exists
|
|
|
|
Different users need different views of the same data. Sales wants to see orders by region. Operations wants orders by status. Each applies different filters, sorts columns differently, and hides irrelevant fields.
|
|
|
|
This QBit lets users save these configurations as named views. Create a view, adjust columns and filters, save it, and switch between views instantly. Views can be private or shared with the team.
|
|
|
|
## Features
|
|
|
|
- **Saved Views** - Store filter, sort, and column configurations
|
|
- **Column Visibility** - Show/hide columns per view
|
|
- **Column Order** - Reorder columns with drag-and-drop
|
|
- **Filter Presets** - Save complex filter combinations
|
|
- **View Sharing** - Share views with roles or all users
|
|
- **Default Views** - Set a view as the default for a table
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- QQQ application (v4.1.0+)
|
|
- QQQ dashboard deployed
|
|
- Database backend configured
|
|
|
|
### Installation
|
|
|
|
Add to your `pom.xml`:
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>com.kingsrook.qbits</groupId>
|
|
<artifactId>qbit-customizable-table-views</artifactId>
|
|
<version>0.3.0</version>
|
|
</dependency>
|
|
```
|
|
|
|
### Register the QBit
|
|
|
|
```java
|
|
public class AppMetaProvider extends QMetaProvider {
|
|
@Override
|
|
public void configure(QInstance qInstance) {
|
|
new CustomizableTableViewsQBit().configure(qInstance);
|
|
}
|
|
}
|
|
```
|
|
|
|
### Enable for Tables
|
|
|
|
```java
|
|
new QTableMetaData()
|
|
.withName("order")
|
|
.withCustomViewsEnabled(true);
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Dashboard Experience
|
|
|
|
Users interact with views through the dashboard:
|
|
|
|
1. Navigate to a table
|
|
2. Adjust columns, filters, and sorting
|
|
3. Click "Save View"
|
|
4. Name the view and set visibility (private/shared)
|
|
5. Switch views from the dropdown
|
|
|
|
### Programmatic View Creation
|
|
|
|
```java
|
|
new QSavedViewMetaData()
|
|
.withName("pendingOrders")
|
|
.withTable("order")
|
|
.withLabel("Pending Orders")
|
|
.withFilter(new QQueryFilter()
|
|
.withCriteria("status", Operator.EQUALS, "pending"))
|
|
.withColumns("orderNumber", "customerName", "total", "createdDate")
|
|
.withSortBy("createdDate", SortOrder.DESC)
|
|
.withSharedWithRoles("sales", "operations");
|
|
```
|
|
|
|
### Default Views
|
|
|
|
Set a view as the default for all users or specific roles:
|
|
|
|
```java
|
|
new QSavedViewMetaData()
|
|
.withName("activeCustomers")
|
|
.withTable("customer")
|
|
.withIsDefault(true)
|
|
.withFilter(new QQueryFilter()
|
|
.withCriteria("status", Operator.EQUALS, "active"));
|
|
```
|
|
|
|
### View Inheritance
|
|
|
|
Create views that extend others:
|
|
|
|
```java
|
|
new QSavedViewMetaData()
|
|
.withName("myPendingOrders")
|
|
.withExtendsView("pendingOrders")
|
|
.withAdditionalFilter(new QQueryFilter()
|
|
.withCriteria("assignedToUserId", Operator.EQUALS, "${currentUserId}"));
|
|
```
|
|
|
|
## Configuration
|
|
|
|
The QBit creates these tables:
|
|
|
|
| Table | Purpose |
|
|
|-------|---------|
|
|
| `saved_view` | View definitions |
|
|
| `saved_view_column` | Column configurations |
|
|
| `saved_view_share` | Sharing permissions |
|
|
|
|
### View Limits
|
|
|
|
```java
|
|
new CustomizableTableViewsQBit()
|
|
.withMaxViewsPerUser(50)
|
|
.withMaxSharedViewsPerTable(20);
|
|
```
|
|
|
|
## Project Status
|
|
|
|
Stable and production-ready.
|
|
|
|
### Roadmap
|
|
|
|
- View folders/categories
|
|
- View usage analytics
|
|
- Export/import view configurations
|
|
|
|
## Contributing
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Run tests: `mvn clean verify`
|
|
4. Submit a pull request
|
|
|
|
## License
|
|
|
|
Proprietary - QRun.IO
|