aurelia-slickgrid

Bug Fixes

• build: incorrect type any (5ffc0a1)
• formatter: add throw error with instruction if missing params (cbb01d9)
• formatter: multipleFormatter should pass value to next formatter (bf6b006)
• pagination: Pagination with BackendServiceApi was incorrect (fba8750)
• requireJS: import for RequireJS should have /index (b796c26)
• sample: fix the client-CLI sample (407ba66)
• sass: all sass properties should have an override capability (6d03cd7)
• utilities: move findOrDefault to a function (#29) (3d21548), closes #27
• formatter: translate formatter was causing issues in some occasion (8acdc28)

Features

• demo: update demo pages with latest features (5d4587d)
• service: expose refreshBackendDataset for backend (68c8266)
• event: #24 add onGridStateChanged and onPaginationChanged events (#28) (b657e75)
  • See the Wiki - Grid State Events for more info

Bug Fixes

• backend: backend filter on delay was broken since GridState feature (a25147d)
• build: fix all build errors (3d24212)
• doc: updated contributing as per comment in #10 (f437e39)
• events: every subscribed event should have an unsubscribe (5abc223)
• events: every subscribed event should have an unsubscribe (31b4e24)
• filter: remove unused function (00b3654)
• graphql: a column type of number should use EQ in GraphQL query (a7da882)
• grid: delete duplicate gridOptions it was causing issues (fb131aa)
• grid: update SlickGrid version and configure Header Menu autoAlign (211ea96)
• odata: OData string filter should also support operators (0bf8928)

Features

• doc: install and setup "prepare-release" for changelog and commit (3925050)
• filter: add new InputNoPlaceholderFilter and global default filter (739ff3f)
• formatter: add a new HyperlinkURI formatter, you need to uriPrefix (52de978)
• grid: add inline editor undo command (72ef747)
• grid: add Pagination page number input (8a89c58)
• query: add excludeFromQuery prop and use it for Row Selection (cda0e39)
• queryFilter: add new "queryFieldFilter" and "queryFieldSorter" (9d2aae1)
• selectEditors: add select grid editors (#22) (5bd7215)
• grid: GridState and Presets (#23)
  • refer to wiki - Grid State & Presets

Features

• Export to File, currently 2 types of exports are supported Wiki - Export to File (PR #16)
  • CSV
  • Text (Tab or Semicolon delimited, or actually any delimiter you wish)
• add positionOrder to change the order position of the "Custom Commands" list showing up in the Grid Menu
• update to latest version of SlickGrid 2.3.13 which brings a few goodies
  • when using Formatters.translate, you can now define it directly in the Grid Options instead of each Column Definition.
• refactored Filter implementation to use a FilterFactory for Filter instantiation (PR #13)
• added a new datasetIdPropertyName grid option which provide a way to use a different property than id (PR #8)
• update to latest SlickGrid version 2.3.13 which brings a few goodies
  • expose new show/hide flags for the ColumnPicker/GridMenu commands of "Force fit column" and "Synchronous Resize", we can now hide them... yay
  • expose new ColumnPicker/GridMenu Slick Event of onColumnsChanged to know what are the remaining columns after removing 1 or many
• update to latest TypeScript version 2.7.2
• expose all Grid/DataView SlickGrid Events to Aurelia via dispatch (PR #6)

Fixes

• fix(gridDestroy): grid destroy missed an event aggregator dispose
• fix(grid): Widen resizable handle cursor areas for columns
• fix(events): missing unsubscribeAll from gridEvent Service

Big Thanks

A big thanks to @jmzagorski for doing a lot of these PRs and putting some orders in the lib :)

Features

• rewrote most of the Filter implementation to make Filters more modular
  • MANDATORY, if you want to use the new filters, you will have to modify your import to include a custom version of multiple-select.js, see the HOWTO for all necessary info on how to import with CLI or WebPack.
  • now support Multiple-Select Filter with SASS variables for styling.
    • uses a customized version of multiple-select.js to suit Aurelia-Slickgrid needs, read Wiki - Select Filter for more info.
  • created Single Select Filter (radio box), again read Wiki - Select Filter for more info.
  • also support Custom Filter, read Wiki - Custom Filter for more info.
• All SlickGrid events are now exposed with delegate binding, they all start with the sg-on prefix
  • for example SlickGrid event onMouseEnter can now be bind directly in the View template with sg-on-mouse-enter.delegate.
  • for more info, read number 3 of Aurelia Grid & DataView Events
  • huge thanks to @jmzagorski for this addition which is also the first community contribution. Keep them coming :)

Fixes

• when rewriting the Filter, I found performance issues there was 2 nested for loop while only 1 loop is enough. So there were performance impact.
• fix inline editor checkbox that were not showing up (completely hidden)
• fix pagination, it should display "1-(itemCount)" when count lower than totalCount
• fix pagination View displayed even when setting "gridOptions.enablePagination=false"
• fix header buttons styling, which was not floating correctly anymore

Deprecated

• Select Filter selectOptions property was renamed collection to make it more generic and re-usable with other Filter that might not be Select.
  • a console warning will be shown if you use the old property name, so it won't break any code. The old property will be removed in later versions.

Features

• add i18n support into Editors.date with Flatpickr
• add Column queryField property to make possible to filter or sort by another field
• add a customStructure property for the select filter to use different key/value pair, see Wiki - Select Filter for more info
• complete rewrite of backendServiceApi
  • add addLocaleIntoQuery property for GraphQL query
  • make the filterTypingDebounce optional, default 750ms
  • make enablePagination totally optional (it will detect when we are using backend service api)
  • make initOptions totally optional and use Pagination options when initOptions doesn't include paging info

Fixes

• fixed Editors.date with latest version of Flatpickr
• fixed pagination a GraphQL pageSize should always be a number not string
• fixed error thrown by SlickGrid of "Stylesheet missing"
• fixed regular grid local filter not working with localization (i18n), 1st column in Example 12
• make column string filter case insensitive and fixed * operator
• fixed pagination resetting "items per page" on filterBy/orderBy change
• pagination, changing page and filter/sort should also reset to page 1

Deprecated

• onBackendEventApi was replaced by backendServiceApi which was a big rewrite and brings a lot of new features (see on top), mainly there's a lot less setup to do at the beginning, the API does a lot of setup by itself.
  • this is for now only a console warning, advising you to use the new API

Fixes

• check grid exist before trying to resize (or auto-resize) the Grid to avoid console error thrown by SlickGrid
• fix an error thrown by SlickGrid when editing a row and highlighting it

New Features

• add info icon Formatter Formatters.infoIcon with has Font Awesome (fa-info-circle)
• add extra SASS border variables for multiple elements
  • border around Header Titles
  • border around Header Filter Row
  • border around ViewPort
• add flag to show/hide Clear Filters & Toggle Filter commands in GridMenu
• add Refresh Dataset command in GridMenu for backendAPI Services only (OData / GraphQL)
• added many new Event Aggregator
  • onDataviewCreated
  • onGridCreated
  • onBeforeGridCreate
  • onBeforeGridDestroy
  • onAfterGridDestroyed

You can see the OnEvent documentation in the Wiki - Grid & DataView Events

Fixes

• fix select Dropdown filter not working correctly with string
• fix highlight row sometime throwing slickgrid error with updateItem

New Features

• add localization to Select dropdown filter
  • example 12 on the demo was also updated to show this change

Fixes

• Add a destroy to the Filter Service to fix an issue showing up with backend services (OData/GraphQL) which was calling 2x times a postProcess introduced by previous version change.
• unsubscribe only when subscriber exist

Fixes

• fix some minor CSS/SASS stylings

New Features

• Localization with i18n
• Add Complex Object Formatter
• GraphQL Service support of Complex Object with dot notation (.)
• Refactored GraphQL Service properties to make it easier to use
  • there's nothing remove though, just addition of properties like columnDefinitions and columnIds that you can pass directly to the GraphQL Service options
• Column Picker and Grid Menu last 2 checkboxes (force fit column & synchronous resize) are now translated.
  • this became possible with the latest version of Slickgrid 2.3.12, make sure you have latest version installed

Fixes

• Pagination should go back to page 1 on Sort and/or Filter Changed
• fix wrong behavior of inline dateEditor with Flatpickr
• fix cannot find stylesheet on element detach/destroy

Small breaking change

• calling the "resizeGrid()" function from the ResizerService no longer requires to pass Grid & Column Definitions objects as arguments. This is to simplify the call when user want to resize the grid.

New Features

• auto-resize columns when onMenuClose of Grid Menu is called
• add outputType to be used with inline editor (currently only DateEditor supports it)

• Fixes

  • leftover filters in a page (by changing route) were carried over in the next route and if they didn't exist were causing error thrown in console. Now watch for route change and perform destroy of certain objects
  • fix GraphQL filter with dropdown, it should use the EQ operator instead of Contains
  • fix GraphQL should cast Observable to Promise also when performing a filter change

• New Features

  • Add row selections with enableCheckboxSelector
  • Single row selection is also supported but you have to use certain gridOptions
  • Review the Wiki - Row Selection for more info

• Some of the CSS seemed invalid for some reason, I just did a rebuilt and republish on NPM and it seem to be
  fixed now.
• Cleaned up the .npmignore to have a cleaner and smaller NPM download
• Added a doc folder which will be use for creating the Github demo page

This is a complete rewrite (2 months in the work) and the dependency changed from Slickgrid-ES6 to the original Slickgrid (6pac fork). Read the README for more details.

There is a lot more documentation in this release, a good place to start is the Wiki - HOWTO Step by Step

If you want to know more about the complete rewrite and breaking change, see the README of the project.

• Tweaked/refactored a few pieces of code to make Aurelia-CLI work
• Remove SlickWindowResizer & SlickPager from import, since they souldn't be invoked directly
• Move slick-pager.scss to be with slick-pager.js so that the require css doesn't fail in the bundle
• Since CLI doesn't support import of images in JS, we can use instead simple variables of their URL (update CLI and Webpack in consequence).
• Again CLI doesn't support import of CSS, I had to remove them from the Plugins (headermenu) and make the CSS available at all time in the global CSS.
• Delete all images from dist, since I don't really use them

• Breaking Change: renamed createDatagrid() to simply createGrid()
• Add missing Plugins directly in aurelia-slickgrid until slickgrid-es6 resolve it's own bundle issue with the Plugins.
• Add Aurelia-Webpack sample available in client-wp folder

This release is the first official working release.
The first few objects you can import are:
import {SlickPager, SlickWindowResizer, SlickService} from 'aurelia-slickgrid';

Examples will come very soon but not today.

Trying to make the Aurelia-Slickgrid plugin to work. I think that only the slickPager should be a globalResources since that is the only piece with View/ViewModel (html/js)