Skip to content

Latest commit

 

History

History
165 lines (109 loc) · 4.21 KB

CHANGELOG.md

File metadata and controls

165 lines (109 loc) · 4.21 KB

@leafygreen-ui/descendants

2.1.5

Patch Changes

2.1.4

Patch Changes

2.1.3

Patch Changes

2.1.2

Patch Changes

2.1.1

Patch Changes

2.1.0

Minor Changes

  • 674d06888: LG-4399: Enable passing component index prop for SSR support

2.0.2

Patch Changes

2.0.1

Patch Changes

2.0.0

Patch Changes

1.0.1

Patch Changes

  • 409377e19: Adds missing useHighlightContext export

1.0.0

Major Changes

  • 4c04aa0ee: Updates useInitDescendants signature to require a Context value, and return a Provider component.

    Eliminates the need to destructure descendants and dispatch from the hook's return value just to pass into the provider. Instead, the hook will construct a pre-populated provider unique to the Context value given.

    Note: descendants, dispatch and getDescendants are still returned by the hook for use in the parent component if necessary.

    Before:

    const MyDescendantContext = createDescendantsContext();
const { descendants, dispatch } = useInitDescendants();

return (
  <DescendantsProvider
    context={MyDescendantContext}
    descendants={descendants}
    dispatch={dispatch}
  >
    <MyDescendantItem />
  </DescendantsProvider>
);

    After:

    const MyDescendantContext = createDescendantsContext();
const { Provider } = useInitDescendants(MyDescendantContext);

return (
  <Provider>
    <MyDescendantItem />
  </Provider>
);

Minor Changes

  • 4c04aa0ee: Adds Highlight management utilities.
    • useHighlight: A hook to initialize the highlight state management
    • HighlightProvider: A context provider for consuming the highlight state from descendant components
    • createHighlightContext: Constructs a unique Context object in order to support nested contexts

Patch Changes

0.3.0

Minor Changes

  • cfa830701: Adds & exports getDescendantById & getDescendantByIndex utilities

Patch Changes

  • cfa830701: Updates Descendant index properties after inserting & removing to ensure the index of the Descendant object matches the index within the Descendants list

0.2.0

Minor Changes

  • 659aa9eed: Adds getDescendants accessor function, returned from useInitDescendants. Use this method when referencing descendants from withing effects/callbacks where the descendants object may have updated, and could be stale.

0.1.1

Patch Changes

  • 15185af0: Imports Storybook utilities from @lg-tools/storybook-utils (previously imported from @leafygreen-ui/lib)
  • 356a53fd: Update TS builds to use [email protected]
  • Updated dependencies [15185af0]
  • Updated dependencies [356a53fd]