@jazzjazzy/enhanced-simple-table v0.1.4

Enhanced Simple Table

A highly customizable table library with advanced filtering capabilities for web applications.

Features

• Dynamic table generation from data arrays/objects
• Responsive design
• Customizable templates
• Theming and styling options:
  • Built-in themes (Dark, Blue, Minimal, High Contrast)
  • Custom theme support
  • CSS customization
  • Accessibility-focused design options
• Advanced filtering capabilities:
  • Text filtering (contains, starts with, ends with, exact match)
  • Numeric filtering (equals, greater than, less than, between)
  • Date filtering (on, before, after, between dates)
  • Boolean filtering (true/false, yes/no)
  • Currency formatting with country code support
  • Fuzzy search with tolerance for typos
  • Regular expression support
  • Multi-select filtering
  • Hierarchical filtering
  • Contextual filters based on column data type
• Filter combinations with AND/OR logic
• Filter groups with nested conditions
• Exclusion filters with NOT conditions
• Cross-column filters
• Filter history tracking
• Saved filters
• Filter suggestions
• Progressive disclosure interface
• Filter visualization
• Data display options:
  • Default (all data)
  • Pagination with customizable page size
  • Endless scrolling for large datasets
• Interactive links:
  • Row-level links for navigation to detail pages
  • Column-specific links for related resources
  • Dynamic URL generation
• Performance optimizations:
  • Debounced filtering
  • Virtualized rendering
  • Worker thread filtering
  • Incremental filtering

Installation

npm install @jazzjazzy/enhanced-simple-table

Basic Usage

<div id="table-container"></div>

<script>
  // Import the library
  import EnhancedSimpleTable from 'filter-table';
  
  // Sample data
  const data = [
    { id: 1, name: 'John Doe', age: 30, joined: '2020-01-15', active: true },
    { id: 2, name: 'Jane Smith', age: 25, joined: '2021-03-20', active: false },
    // More data...
  ];
  
  // Initialize the table
  const table = new EnhancedSimpleTable('#table-container', {
    data: data,
    columns: [
      { field: 'id', title: 'ID', filterable: true },
      { field: 'name', title: 'Name', filterable: true },
      { field: 'age', title: 'Age', filterable: true, filterType: 'number' },
      { field: 'joined', title: 'Join Date', filterable: true, filterType: 'date' },
      { field: 'active', title: 'Active', filterable: true, filterType: 'boolean' }
    ]
  });
</script>

Advanced Filtering

// Add a fuzzy search filter
table.addFilter({
  column: 'name',
  type: 'fuzzy',
  value: 'smith',
  tolerance: 0.3
});

// Add a filter group with OR logic
table.addFilterGroup({
  operator: 'OR',
  filters: [
    { column: 'age', type: 'range', min: 25, max: 35 },
    { column: 'joined', type: 'after', value: '2020-01-01' }
  ]
});

// Save current filters
const savedFilter = table.saveCurrentFilters('my-favorite-view');

// Apply saved filters later
table.applyFilters(savedFilter);

Pagination and Endless Scrolling

// Import the library
import EnhancedSimpleTable from 'filter-table';

// Initialize the table with pagination
const table = new EnhancedSimpleTable('#table-container', {
  data: data,
  columns: columns,
  pagination: {
    enabled: true,
    pageSize: 10,
    currentPage: 1,
    pageSizeOptions: [10, 25, 50, 100]
  }
});

// Or initialize with endless scrolling
const tableWithEndlessScrolling = new EnhancedSimpleTable('#table-container-2', {
  data: data,
  columns: columns,
  endlessScrolling: {
    enabled: true,
    itemsPerLoad: 20,
    loadMoreThreshold: 200,
    initialItems: 20
  }
});

// Change display mode after initialization
table.setDisplayMode('pagination', { pageSize: 25 });
table.setDisplayMode('endlessScrolling', { itemsPerLoad: 30 });
table.setDisplayMode('default'); // Show all data

// Pagination controls
table.goToPage(3); // Go to page 3
table.changePageSize(50); // Change page size to 50 rows

// Listen for pagination events
table.on('pageChange', (event) => {
  console.log(`Page changed to ${event.currentPage} of ${event.totalPages}`);
});

table.on('pageSizeChange', (event) => {
  console.log(`Page size changed to ${event.pageSize}`);
});

// Listen for endless scrolling events
table.on('loadMore', (event) => {
  console.log(`Loaded ${event.loadedItems} of ${event.totalItems} items`);
});

Currency Formatting

// Import the library and formatCurrency function
import EnhancedSimpleTable from 'filter-table';
import { formatCurrency } from 'filter-table/utils/data-types.js';

// Sample data with country codes
const data = [
  { id: 1, name: 'John Doe', salary: 85000, country: 'US' },
  { id: 2, name: 'Jane Smith', salary: 65000, country: 'GB' },
  // More data...
];

// Initialize the table with currency formatting
const table = new EnhancedSimpleTable('#table-container', {
  data: data,
  columns: [
    { field: 'id', title: 'ID' },
    { field: 'name', title: 'Name' },
    { 
      field: 'salary', 
      title: 'Salary', 
      dataType: 'currency',
      formatter: function(value, row) {
        return formatCurrency(value, row.country);
      }
    },
    { field: 'country', title: 'Country' }
  ]
});

For detailed currency formatting documentation, see the Currency Formatting Guide.

Interactive Links

// Import the library
import EnhancedSimpleTable from 'filter-table';

// Sample data
const data = [
  { id: 1, name: 'John Doe', department: 'Engineering', position: 'Software Engineer' },
  { id: 2, name: 'Jane Smith', department: 'Marketing', position: 'Product Manager' },
  // More data...
];

// Initialize the table with links
const table = new EnhancedSimpleTable('#table-container', {
  data: data,
  // Row-level link - makes the entire row clickable
  rowLink: 'user.html?id={id}',
  columns: [
    { field: 'id', title: 'ID' },
    { field: 'name', title: 'Name' },
    { 
      field: 'department', 
      title: 'Department',
      // Column-specific link - only the department text is a link
      link: 'department.html?name={value}'
    },
    { field: 'position', title: 'Position' }
  ]
});

// Dynamic links using functions
const tableWithDynamicLinks = new EnhancedSimpleTable('#table-container-2', {
  data: data,
  // Dynamic row-level link function
  rowLink: (row) => `user.html?id=${row.id}&name=${encodeURIComponent(row.name)}`,
  columns: [
    // column definitions...
    { 
      field: 'department', 
      title: 'Department',
      // Dynamic column-specific link function
      link: (value, row) => `department.html?name=${encodeURIComponent(value)}&company=acme`
    }
  ]
});

For detailed links documentation, see the Links Guide.

Styling and Theming

// Initialize with a theme
const table = new EnhancedSimpleTable('#table-container', {
  data: data,
  columns: columns,
  styling: {
    theme: 'dark', // Use the dark theme
    // Optional: Specify a custom path to theme stylesheets
    themesPath: './path/to/themes/'
  }
});

// Change theme after initialization
table.setTheme('blue');

// Get available themes
const themes = table.getAvailableThemes();
console.log(themes); // ['dark', 'blue', 'minimal', 'high-contrast']

// Load a custom stylesheet
table.loadCustomStylesheet('path/to/custom-theme.css');

// Apply a custom theme (defined in the custom stylesheet)
table.setTheme('custom-theme');

For detailed styling documentation, see the Styling Guide.

Documentation

For full documentation, see the docs directory or visit our documentation site.

Examples

Check out the examples directory for more usage examples:

• Basic Example
• Advanced Example
• Currency Example
• Links Example
• Styling Example
• Pagination Example

License

MIT