This fork is specifically created for https://github.com/janisdd/vscode-edit-csv because I want to keep the MIT license (and also MIT for the vs code plugin) which was only valid until (including) handsontable version 6.2.2 (https://github.com/janisdd/handsontable)

Note that the dist might not be up to date (!!!), you need to run npm run build to get the output (dist/)

For development you can run build:umd for faster build times

Below is a list of changes made to this repo (latest first)

• (6.5.4)

  • added option setFillFunction to autoFill plugin
  • allows to specify how to fill the data (custom function)
  • ensures that the correct number of fill data is returned
    • else falls back to default behavior (copying)
  • added option pasteScrollBehavior to copyPaste plugin
    • scrollToLastPastedCell (default) previous behavior: will scroll to the last pasted cell
    • scrollToFirstPastedCell: will scroll to the first pasted cell
    • dontScroll: do not scroll to the pasted cells
    • note: pasted cells are still selected
  • removed onCellCornerDblClick function from the autoFill plugin
    • it used to fill in all other cells in the column if they were empty?
    • does not work with our implementation of custom fill function

• (6.5.3)

  • added functions to hot instance: isListeningPaused(): bool, setListeningPaused(bool)
    • can be used to pause listening for keyDown events
      • this is checked before the rest of editorManager > onKeyDown is run, so the instance hook beforeKeyDown can set this to prevent, e.g., start editing the cells
      • to undo this after the key press use this pattern:

    hot.setListeningPaused(true)
    setTimeout(() => {
      hot.setListeningPaused(false)
    }, 0)

    • [hot instance].isListening now also checks isListeningPaused

• (6.5.2)

  • the autoColumnSize plugin is no longer disabled when handsontable colWidths setting is used
  • though I don't use colWidths really, only to hide columns, for column sizes I use the manualColumnResize plugin
  • removed the minimum size for the manualColumnResize plugin (to be able to hide columns)
  • changed core.js > _getColWidthFromSettings to do the same thing as the rows... (prevented something for hiding columns feature)

• (6.5.1): fixed an issue where disabling autoColumnSize and manualColumnSize Plugins would add more and more callbacks (other methods than onBeforeColumnResize still do that but not that important)

  • this was critical because this would only skip prior registered callbacks
  • which means that user handlers would eventually be the first callback that is run... but we need to old column size (which we only get when autoColumnSize Plugin's callback is called first)
  • solved by passing reference to the addHook methods (which will unskip the methods when re-adding)
  • however, now we need to re-enable the AutoColumnPlugin every time the hot settings are updated!

• added setting for autoColumnSize plugin: ignoreCellWidthFunc (null or function),

  • function takes the cell value (string) and returns true: cell should be ignored (width), false: not
  • instance of this is not specified (could be handsontable this or caller this... [not tested])

• we no longer push dist to github... to reduce overhead

• added setting for copyPaste plugin: pasteSeparatorMode

  • with the options "normal" | "ignoreRowSeparators" | "ignoreColumnSeparators" | "ignoreAllSeparators"
  • this will re-join the cells after processing
    • this means sheet.js processing is applied and splits the cells, we join them again
  • normal: all separators are applied (what one would expect)
  • onlyKeepColumnSeparators: we only keep columns (ignore row separators) (1 row)
  • onlyKeepRowSeparators: we only keep rows (ignore column separators) (with 1 column)
  • ignoreAllSeparators: everything will be pasted into one cell
  • added setting pasteRowSeparator: which is used to combine the rows again
  • added setting pasteColumnSeparator: which is used to combine the columns again

• fixed issue when pasting table data from excel/libreoffice/openoffice

  • e.g. pasting from excel introduced line breaks because table styling but was not removed
  • see src/plugins/copyPaste/utils.js > tableToArray (mostly from handsontable update)

• when a cell is selected (not focused, no cursor) and we start typing the cell content is cleared

  • however, when we input a non-printable character (e.g. AudioVolumeMute, LaunchApplication1, ... see editorManager.js for all) the cell content is cleared but no character is entered
  • we cancel content clear for these keyCodes: AudioVolumeMute, AudioVolumeDown, AudioVolumeUp, LaunchMediaPlayer, LaunchApplication1, LaunchApplication2, num lock, scroll lock, pause/break
  • we don't use isPrintableChar in case it misses some (other language) keys
  • when starting a composed character we only clear the cell after the second key press
    • ^ + a will clear the cell and input â but not ^

• autoColumnSize doube click auto resize now works properly even if the plugin is disabled

• sort plugin now supports multi column sorting (always enabled)

  • sue ctrl/cmd to sort by the next column

• fixed issue where fixedRowsTop and fixedColumnsLeft could not be changed/set after we removed a row/col

• fix for issue handsontable#6232

• fixed issue where setting wordWrap: false will not display new lines any more

  • this cannot be easily merged into handsontable because the fix will always preserve whitespace even if trimWhitespace: true which will break the current behaviour of handsontalbe
  • current behaviour is - trimWhitespace: true then whitespace (and new lines) is collapsed visually and trim is applied after cell edit
  • behaviour after fix is - trimWhitespace: true then whitespace (and new lines) is visible and trim is applied after cell edit
  • see handsontable#6232 (comment) for some more information

• added option autoColumnSize to Plugin maxColumnWidth (number|function) which allows to specify a max width for the very first render

  • usage:

    let hand = {
      autoColumnSize: {
        maxColumnWidth: function(columnIndex: number, column_width: number) {
          // columnIndex is visual or physical?? probably visual TODO
          // you can return a new width here...
        }
      }
    }
    let hand2 = {
      autoColumnSize: {
        maxColumnWidth: 300
      }
    }

• modified search plugin to support

  • suspend (swap match css class with another one)
  • async search to update ui and support cancelling

---

Handsontable Community Edition (CE) is an open source JavaScript/HTML5 data grid component with spreadsheet look & feel. It easily integrates with any data source and comes with a variety of useful features like data binding, validation, sorting or powerful context menu. It is available for Vue, React, Angular and Polymer.

If you are looking for an extended version, try out Handsontable Pro.

---

We are looking for Contributors who would like to help us with translations. Learn more
Most wanted languages: Danish, Portuguese, Spanish and Swedish.

---

Table of contents

1. What to use it for?
2. Installation
3. Basic usage
4. Examples
5. Features
6. Screenshot
7. Resources
8. Wrappers
9. Support
10. Contributing
11. Community
12. License

What to use it for?

The list below gives a rough idea on what you can do with Handsontable CE, but it shouldn't limit you in any way:

• Database editing
• Configuration controlling
• Data merging
• Team scheduling
• Sales reporting
• Financial analysis

Installation

There are many ways to install Handsontable CE, but we suggest using npm:

npm install handsontable

Alternative ways to install

• See the download section on how to install Handsontable CE using nuget, bower, yarn and more.

Basic usage

Assuming that you have already installed Handsontable CE, create an empty <div> element that will be turned into a spreadsheet:

<div id="example"></div>

In the next step, pass a reference to that <div> element into the Handsontable CE constructor and fill the instance with sample data:

var data = [
  ["", "Tesla", "Volvo", "Toyota", "Honda"],
  ["2017", 10, 11, 12, 13],
  ["2018", 20, 11, 14, 13],
  ["2019", 30, 15, 12, 13]
];

var container = document.getElementById('example');
var hot = new Handsontable(container, {
  data: data,
  rowHeaders: true,
  colHeaders: true
});

Examples

• See a live demo

Features

Some of the most popular features include:

• Sorting data
• Data validation
• Conditional formatting
• Freezing rows/columns
• Merging cells
• Defining custom cell types
• Moving rows/columns
• Resizing rows/columns
• Context menu
• Adding comments to cells
• Dragging fill handle to populate data
• Internationalization
• Non-contiguous selection

See a comparison table

Screenshot

Resources

• API Reference
• Compatibility
• Change log
• Roadmap
• Newsroom

Wrappers

Handsontable CE comes with wrappers and directives for most popular frameworks:

• Angular
• Angular 1
• React
• Vue
• Polymer
• Typescript file

Support

Report all the suggestions and problems on GitHub Issues.

An open source version doesn't include a commercial support. You need to purchase Handsontable Pro license or contact us directly in order to obtain a technical support from the Handsoncode team.

Contributing

If you would like to help us to develop Handsontable, please take a look at this guide for contributing.

Community

• GitHub issues
• Stackoverflow
• Forum
• Twitter

License

Handsontable Community Edition is released under the MIT license. Read license.

Copyrights belong to Handsoncode sp. z o.o.