@bouzu/vue-virtualizer

  • Version 0.0.3
  • Published
  • 22.4 kB
  • 8 dependencies
  • MIT license

Install

npm i @bouzu/vue-virtualizer
yarn add @bouzu/vue-virtualizer
pnpm add @bouzu/vue-virtualizer

Overview

[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![bundle][bundle-src]][bundle-href] [![JSDocs][jsdocs-src]][jsdocs-href]

Index

Functions

function useVirtualizer

useVirtualizer: <T extends object>(
props: UseVirtualizerProps<T>
) => Virtualizer<T>;

    function useVirtualizerContext

    useVirtualizerContext: <T extends object>() => VirtualizerContext<T>;

      function useVirtualizerItem

      useVirtualizerItem: <T extends object>(
      props: UseVirtualizerItemProps<T>,
      context?: VirtualizerContext<T>
      ) => void;

        function useVirtualList

        useVirtualList: <T extends object>(
        props: UseVirtualListProps<T>
        ) => VirtualList<T>;

          Interfaces

          interface UseVirtualizerItemProps

          interface UseVirtualizerItemProps<T extends object> {}

            property el

            el: MaybeRef$1<HTMLElement | null | undefined>;

              property view

              view: MaybeRef$1<View<T>>;

                interface UseVirtualizerProps

                interface UseVirtualizerProps<T extends object> {}

                  property anchorScrollPosition

                  anchorScrollPosition?: MaybeRef<CreateVirtualizerProps['anchorScrollPosition']>;

                    property data

                    data: MaybeRef<T[]>;

                      property el

                      el: MaybeRef<HTMLElement | null | undefined>;

                        property layouts

                        layouts: MaybeRef<Layouts<T>>;

                          property overscanThrottle

                          overscanThrottle?: MaybeRef<CreateVirtualizerProps['overscanThrottle']>;

                            interface Virtualizer

                            interface Virtualizer<T extends object> {}

                              property collect

                              collect: Virtualizer$1<T>['collect'];

                                property contentSize

                                contentSize: Readonly<Ref<Size>>;

                                  property context

                                  context: VirtualizerContext<T>;

                                    property isScrolling

                                    isScrolling: Readonly<Ref<boolean>>;

                                      property visibleRect

                                      visibleRect: Ref<Rect>;

                                        property visibleViews

                                        visibleViews: Readonly<Ref<View<T>[]>>;

                                          interface VirtualizerContext

                                          interface VirtualizerContext<T extends object> {}

                                            property state

                                            state: Virtualizer$1<T>;

                                              Type Aliases

                                              type UseVirtualListProps

                                              type UseVirtualListProps<T extends object> = Omit<
                                              UseVirtualizerProps<T>,
                                              'layouts'
                                              > & {
                                              axis?: MaybeRef$1<CreateListLayoutsOptions['axis']>;
                                              itemSize?: MaybeRef$1<CreateListLayoutsOptions['itemSize']>;
                                              estimatedItemSize?: MaybeRef$1<CreateListLayoutsOptions['estimatedItemSize']>;
                                              };

                                                type VirtualList

                                                type VirtualList<T extends object> = Virtualizer<T>;

                                                  Package Files (1)

                                                  Dependencies (8)

                                                  Dev Dependencies (3)

                                                  Peer Dependencies (2)

                                                  Badge

                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@bouzu/vue-virtualizer.

                                                  • Markdown
                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@bouzu/vue-virtualizer)
                                                  • HTML
                                                    <a href="https://www.jsdocs.io/package/@bouzu/vue-virtualizer"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>