x-editable-bs5/dist/README.md

X-Editable (Bootstrap 5 Fork)

A drop-in replacement for legacy Bootstrap 3 x-editable projects, modernized for Bootstrap 5 with jQuery support.

Why This Fork?

This project was created when we needed a drop-in replacement for x-editable in a legacy Bootstrap 3 project. The original vitalets/x-editable library has not been actively maintained and doesn't support Bootstrap 5.

Key Features:

• Bootstrap 5 compatibility
• jQuery support maintained
• Select dropdowns - fully functional
• Select2 support - advanced select with search/ajax
• Date pickers - using bootstrap-datepicker
• Drop-in replacement - minimal code changes needed
• Streamlined codebase - Bootstrap 5 only, legacy code removed

Demo

The /demo folder contains working examples of the library in action.

To run the demo:

# In the project root directory
php -S 0.0.0.0:8000

# Then visit: http://localhost:8000/demo/

The demo showcases:

• Select inputs with AJAX and static data sources
• Select2 inputs with search functionality (requires select2 library)
• Date picker functionality
• Basic in-place editing

Installation

Via npm

npm install x-editable-bootstrap5

Dependencies

This library automatically installs and requires:

• Bootstrap 5 (CSS and JS)
• jQuery 3.x
• bootstrap-datepicker (for date inputs - included as dependency)
• select2 (for select2 inputs - included as dependency)

Quick Start

1. Include the CSS and JS files:

<!-- Bootstrap 5 -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"></script>

<!-- jQuery -->
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>

<!-- Bootstrap Icons -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css" rel="stylesheet">

<!-- Bootstrap Datepicker -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap-datepicker/1.10.0/css/bootstrap-datepicker.min.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap-datepicker/1.10.0/js/bootstrap-datepicker.min.js"></script>

<!-- X-Editable Bootstrap 5 -->
<link href="dist/bootstrap5-editable/css/bootstrap-editable.css" rel="stylesheet">
<link href="dist/bootstrap5-editable/css/select2.min.css" rel="stylesheet">
<script src="dist/bootstrap5-editable/js/bootstrap-editable.js"></script>

Or using npm/webpack:

import 'bootstrap/dist/css/bootstrap.min.css';
import 'bootstrap/dist/js/bootstrap.bundle.min.js';
import 'bootstrap-icons/font/bootstrap-icons.css';
import 'bootstrap-datepicker/dist/css/bootstrap-datepicker.min.css';
import 'bootstrap-datepicker/dist/js/bootstrap-datepicker.min.js';
import 'x-editable-bootstrap5/dist/bootstrap5-editable/css/bootstrap-editable.css';
import 'x-editable-bootstrap5/dist/bootstrap5-editable/css/select2.min.css';
import 'x-editable-bootstrap5/dist/bootstrap5-editable/js/bootstrap-editable.js';

2. Initialize editable elements:

$('#my-editable').editable({
    type: 'select',
    source: [
        {value: 1, text: 'Option 1'},
        {value: 2, text: 'Option 2'}
    ],
    url: '/update-endpoint'
});

Select2 Support

This library includes built-in support for Select2 inputs, providing enhanced select functionality with search, AJAX loading, and more.

Note: Select2 is included as an npm dependency and will be automatically installed when you install x-editable-bootstrap5.

Quick Select2 Setup

Use select2 type in your editable:

$('#my-select2').editable({
    type: 'select2',
    source: [
        {id: 'us', text: 'United States'},
        {id: 'gb', text: 'Great Britain'},
        {id: 'de', text: 'Germany'}
    ],
    select2: {
        placeholder: 'Select Country',
        allowClear: true
    },
    url: '/update-endpoint'
});

Select2 with AJAX

$('#ajax-select2').editable({
    type: 'select2',
    select2: {
        placeholder: 'Search countries...',
        minimumInputLength: 2,
        ajax: {
            url: '/search-countries',
            dataType: 'json',
            data: function (term) {
                return { query: term };
            },
            results: function (data) {
                return { results: data };
            }
        }
    },
    url: '/update-endpoint'
});

Migration from Bootstrap 3

If you're migrating from the original x-editable:

1. Update Bootstrap to version 5
2. Replace x-editable files with this Bootstrap 5 version (bootstrap-datepicker included as dependency)
3. Update CSS classes if using custom styling (Bootstrap 3 → 5 changes)

The JavaScript API remains largely the same, making it a true drop-in replacement.

Build

To build the library from source:

# Install dependencies
npm install

# Build with Grunt
grunt build

# Or build with webpack for demo
npx webpack --mode=development

Repository

Main Repository: git.24unix.net/tracer/x-editable-bs5

Mirrors:

• GitHub: github.com/24unix/x-editable-bs5
• GitLab: gitlab.com/24unix/x-editable-bs5

Development happens on the main repository at git.24unix.net, with mirrors automatically synced to GitHub and GitLab.

License

This project maintains the same MIT license as the original x-editable project.

Credits

• Original x-editable by Vitaliy Potapov
• Bootstrap 5 modernization and maintenance by this fork