Skip to content

Latest commit

 

History

History
160 lines (102 loc) · 4.37 KB

CHANGELOG.md

File metadata and controls

160 lines (102 loc) · 4.37 KB
Raw

1.0.1

  • Type fix, now items array accepts null, undefined or boolean for conditional items.

1.0.0

Features

  • Now items prop supports nested array of items like Vue/React render function, nested arrays are converted to vNode[] in render phase.
  const items = [
    item(...),

    users.map((user) => item(user)), // Item[],

    itemGroup({
      key: '__',
      items: [
        item(...),
        [
          customItem(...)
        ]
      ]
    })
  ]

0.5.0

Features

  • Now itemDefaults prop accepts a function that has item passed as parameter, for type safety createItemDefaults is updated as well.

Breaking Changes

  • Now instead of passing meta to render slot #render="meta" it passed whole item data #render="{ meta, disabled, onSelect }". This will be helpful for detecting disabled state etc.

0.4.1

Improvements

  • Now instead of creating a renderer function on every render, SelectableItems now returns render function from setup and renderer function is created only once per component. This will increase performance a bit but not recognizable.

0.4.0

### Features

  • New itemDefaults prop to create default options for all selectable items can be created.

  • New createItemDefaults(options: ItemDefaults) function for default options, this function will wrap wrapperComponentOrTag with markRaw if component is given.

Bug Fixes

  • Fixed not wrapping functional components with markRaw in item() and itemGroup().

0.3.1

Bug Fixes

  • Fixed types of hooks/events.
  • Context['selectFocusedElement'] was incorrect name, fixed to correct one Context['selectFocusedItem']

0.3.0

Features

  • Now focus event/hook has a fourth parameter byPointer: boolean. If user is focused to an item by pointer this parameter will be true otherwise false.

  • Now DOMFocus event has four arguments. Frst argument of DomFocus event is Focus Event, rest is Meta, Item<Meta>, HTMLElement.

Breaking Changes

  • Removed itemHover event and Context['onHover'] hook, use focus with fourth parameter instead.

0.2.3

Project Refactors

  • Removed unused variables from setup return.

0.2.2

Doc Updates

  • Updated readme

0.2.1

Features

  • Now ItemOptions have disabled option. Disabled items have vue-selectable-items-item-disabled class. 
    item({
  key: 'myKey',
  disabled: true
})

Bug Fixes

  • If current focused item key doesn't exist anymore, focus will be resetted.

0.2.0

Features

  • itemFocus, itemUnfocus, itemDOMFocus, itemHover emits are added.

  • SelectableItems component now exposes Context as template ref.

  • Now all events has 3 arguments; Meta, Item and HTMLElement.

  • New exported functions filterSelectableAndCustomItems and filterSelectableItems.

  • Now onSelect property of an item has correct type support.

  • Breaking Changes

    • getItemMetaDataByKey renamed as getItemMetaByKey with generic support. getItemMetabyKey<Meta = unknown>

    • getSelectableItems now supports generic. getSelectableItems<Meta = unknown>

    • getFocusedElement renamed as getFocusedItemElement

    • onMouseEnter renamed as onHover


0.1.1

Doc Updates

  • Updated readme.

0.1.0

  • itemGroup() and item() now wraps given wrapperComponentOrTag with markRaw for performance optimization.
  • itemGroup() and item() now has type support for wrapperProps.
  • onClick(meta) property of item() now has correct types.
  • Added data-vue-selectable-items-item to selectable item elements to help users query items like document.activeElement.hasAttribute('data-vue-selectable-items-item').

Breaking Changes

  • Now each item requires a unique key, old approach was creating a random key for each item but that wasn't a good choice because most people are creating items in a computed and computed creates unique key for each trigger. This makes all items to rerender even if they didn't change.

  • itemGroup, customItem and item functions are now expecting 1 argument as object and has generic meta type support.

  • metaData renamed to meta and.

  • slotName option of CustomItem renamed as name.


0.0.2

  • Added new functions to setup prop arguments.
  • Exported missing types.