README

Comment installer Cheetah Framework

npm install cheetah-framework

Add an eslint config file with a minimum of this.

module.exports = {
  'extends': [
    'cheetah-framework/.eslintrc.js'
    // 'commerce-project/.eslintrc.js' // example that extends commerce, that extends cheetah-framework
  ]
}

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[UNRELEASED] YYYY-MM-DD

[1.28.5] YYYY-MM-DD

Added

• Add NoInitialFetch option on remote input to prevent fetching all values before typing

Changed

• Change 'PROD' label in menu to show nothing while in production

[1.28.4] 2025-07-03

Fixed

• Fix non-collapsible form-group collapsing on toggle

Added

• Add padding/cursor pointer/hover color on collapse icon

[1.28.3] 2025-06-18

Added

• Add new title-actions slot in form-group so we can append buttons that won't trigger a toggle collapse

[1.28.2] 2025-06-11

Fixed

• Fix icons rotating 90° in form group header when collapsed
• Fix buttons/i elements within form group header causing a toggle collapse when it should not

[1.28.1] 2025-06-10

Added

• Add payload parameter to get method in LaravelModel

[1.28.0] 2025-05-12

Added

• Add support for Laravel Reverb

Fixed

• Fix admin menu needs multiple click to open after closed with overlay click

[1.27.1] 2025-04-17

Fixed

• Fix confirm alert flushing options when message is null

[1.27.0] 2025-03-26

Added

• Add visual indicator of the environment in left navbar
• Add components.loginForm config to allow overriding default login form
• Add silentUpdate boolean prop to refresh a grid without replacing the items with the loading component;

Fixed

• Fix pageSize not being in the default select values;
• Framework variables overriding
• Fix text wrapping on FormGroup title

[1.26.1]

Fixed

• Fix invalid criteria by adding prevent update on error option

[1.26.0]

Fixed

• fix query builder not_exist condition never matching.

Changed

• Change exist and not_exist to use HasCriteria and DoesntHaveCriteria respectively.
• Change LaravelModel::all() to use a POST request simulating a GET so we can send data in the body of the request.

[1.25.5]

Fixed

• Fix query builder ignoring relations deep.

[1.25.4]

Fixed

• Fix using scrollToFirstError in modal scroll in document instead
• Fix formError mixin reactivity

[1.25.3] 2025-02-05

Added

• New quickFilterMinSearchCharacters prop on Grid.vue

[1.25.2] 2024-11-15

Fixed

• Fix reorder backend call error with attribute values of cheetah-attribute package

[1.25.1] 2024-10-01

Fixed

• Remove many RecursiveDetailRow i18n warning for missing translations

[1.25.0] 2024-09-25

Added

• New ModelRelationInput component to dynamically add/delete/reorder relations on a model

Changed

• Change FormGroup's header to be clickable all the way when collapsible
• Query builder enum field is now filterable

[1.24.0] 2024-03-28

Added

• New slots to customize grid display (See card view in cms)
• New way to configure split regex either using defaultSplitRegExp for the whole project or a prop directly on the grid

Fixed

• Fixed RecursiveDetailRow error with external data

[1.23.3] 2024-03-06

Added

• Resizable bar in secondary menu

[1.23.2] 2024-02-07

Removed

• Remove tree component example and style (since it conflicted with new cheetah-tree package)

[1.23.1] 2024-02-07

Changed

• Change kicker component (for lock) into a button, so that it is clearer that we can click it

[1.23.0] 2024-01-26

Added

• Cookie util
• Fixed lang not being correctly sent to backend

[1.22.5] 2023-11-03

Added

• Grid: Backend can now return meta_data field that will be returned on new 'update' event and accessible in the grid Api

[1.22.4] 2023-08-30

Fixed

• Fix grid selection ignoring grid localScopes

[1.22.3] 2023-08-30

Added

• Add readonly feature to Query builder

[1.22.2] 2023-05-31

Fixed

• Rollback bootstrap version

[1.22.1] 2023-05-30

Fixed

• Fix error compiling with node 18

[1.22.0] 2023-05-15

Added

• Add application version in profile panel and login page

Fixed

• Fix re-render fo router-view when hideMenu option is true

[1.21.1] 2023-05-08

Fixed

• Fix compilation for packages

[1.21.0] 2023-04-14

Added

• Add an option to make imageUploader disableable
• Add get multiple errors method

Changed

• Remove usage of eslint-config-vue

Fixed

• Hide menu group if no permitted children
• Fix i18n console warning

[1.20.0] 2023-03-20

Added

• Add disable option for imageUploader input.
• Remove usage of eslint-config-vue.
• Improve eslint config.
• Hide menu group if not contains permitted children.
• Add disable related language input for InputText component.

[1.19.0] 2023-01-17

Added

• Add new Laravel Echo options in base config

[1.18.0] 2023-01-06

Added

• Add customCriteria handler and splitRegex with RemoteInput to build custom queries.

[1.17.0] 2022-12-16

Added

• Add post mutators

Fixed

• Fix menu always displayed in french locale
• Fix can't get email of undefined

[1.16.1] 2022-12-02

Fixed

• Make bread router link element a router link
• Fix menu not visible because of JS error

[1.16.0] 2022-10-26

Added

• Add session expire handler

Fixed

• Fix form option merge strategy

[1.15.0] 2022-10-11

Added

• Add user profile sub menu with a custom component slot instead of a simple logout button
• Change login title component config location with config.components.loginTitle
• Add logout method handler (use current logout behaviour as default)
• Add memoization to model for mutators (performance improvement)

[1.14.2] 2022-09-06

Fixed

• Fix Reorderer component not compatible with toolbox list response

[1.14.1] 2022-08-23

Fixed

• Fix copy button inline style not overridable

[1.14.0] 2022-08-23

Added

• Add disable lock option

[1.13.2] 2022-08-08

Added

• Add initial boolean param to RemoteInput input event

Fixed

• Fix remote input does not returning remote instance on init
• Fix bootstrap version to prevent build error

[1.13.1] 2022-07-29

Fixed

• Fix npm build crashing with undefined variable when using bootstrap 5.2

[1.13.0] 2022-07-28

Added

• Added the possibility to disable tabView from changing the url
• Allow hiding of page layout header

Fixed

• Fix LaravelModel.all() loosing requested scopes with model using baseScopes

[1.12.1] 2022-03-29

Fixed

• Fix npm published version

[1.12.0] 2022-03-29

Added

• Grid
  • Change grid clear selection button style
  • Move grid multi select actions below selected item message
  • Grid selection is now a model
• Laravel Model
  • Fix bulkUpdate not returning response
  • Add LaravelModel baseCriteria and base scopes functionality
• Add datepicker mixin with format config

[1.11.2] 2022-02-08

Fixed

• Form improvement and fix
  • Add error fallback error message when no errors appear in the form.
  • Add scroll to the first error.
  • Add new method "callSaveMethod" to use on el-button and prevent console error.

[1.11.1] 2022-02-07

Added

• Add more grid slots.

Fixed

• Add missing vuedraggable dependency.
• Fix grid slot not visible when using as scopedSlot.
• Fix undesirable top border on grid inside form group.
• Fix absolute admin image urls.

[1.11.0] 2022-01-24

Added

• Add csrf and more to headers to uploader components.
• Add additional headers option on uploader components.
• Add custom label prefix for query-builder.
• Add grid filters utility class to automate some code in grid filters.

Fixed

• Fix display of multiple errors of a same property.
• Fix some usages of idKey property in LaravelModel and form.

[1.10.1] 2021-10-22

Fixed

• Fix unwanted links underscore.

[1.10.0] 2021-10-13

Changed

• Update to bootstrap 5 css library.

[1.9.3] 2021-09-23

Changed

• Change display of <pre> and <code> tag.

[1.9.2] 2021-09-23

Fixed

• Fix form error inline position.

[1.9.1] 2021-09-22

Fixed

• Fix double css include in generate scss file.

[1.9.0] 2021-09-08

Added

• Add grid props for el-table customization purpose.

[1.8.0] 2021-08-05

Added

• Add custom login logo option.

Fixed

• Fix localized inputText have duplicated labels while using label slot.

[1.7.0] 2021-06-10

Added

• Add new PageLayout title slot.
• Add loading component customisations.
• Allow to pass lock object to kicker as a prop.

Changed

• Change kick behaviour to force kick after 30 seconds instead.

[1.6.1] 2021-05-28

Fixed

• Fix numeric values in criteria by adding remote criteria handler.

[1.6.0] 2021-05-27

Added

• Add lock feature.

[1.5.1] 2021-05-17

Fixed

• Fix can't login admin.

[1.5.0] 2021-05-14

Added

• Add RemoteInput sort option.
• Update Tip component background colors to make them more apparent.

Fixed

• Fix InfoBlock component to prevent error if not in a el-form component.

[1.4.0] 2021-05-04

Added

• Add new updateExcept method to LaravelModel.
• Add 2 new form group style. Level 0 inside level 0 and tree style.
• Add initialValue to remote input to prevent unnecessary requests.

Changed

• Refactor Form save method override to support both store and update method.

Fixed

• Fix redirect to login after login.

[1.3.0] 2021-04-23

Added

• Add collapsible header with FormGroup.
• Add possibility to change true value color of a Boolean component.
• Add new component ReorderDialog.
• Add go last / go first action with Reorderer component.
• Add new danger type with Tip component.
• Add Form save method override capability.
• Add user access in components via $root.user.
• Add user roles/permissions.
• Add show/hide menus based on roles/permissions.
• Add new LaravelModel method updateOnly to send only specific fields to the backend.

Changed

• Change styling of LocalizedDetailRow component.

Fixed

• Other minor fixes.

[1.2.2] 2021-03-26

Added

• Add support for icon component in the menu.

[1.2.1] 2021-03-24

Added

• New login screen.
• Add new loadScript utility.

Fixed

• Other fixes

[1.2.0] 2021-01-21

Added

• Redirect to login on unauthenticated actions.
• Add new Error RouterError.
• New CheetahStore preventFetch option.
• Add chunk file hash to prevent browser caching.