svelte-common

svelte-common common components utils used in svelte apps# usageCheck out the code in the example folder,

or the live example.

API### Table of Contents* AttributeDefinition

*   [Properties](#properties)

• tokens
  • Parameters
• setAttribute
  • Parameters
• getAttribute
  • Parameters
• getAttributeAndOperator
  • Parameters
• filter
  • Parameters
• Pagination
  • Parameters
  • page
    • Parameters
  • page
  • items
  • pageNavigationElement
• initializeServiceWorker
  • Parameters
• toggleOrderBy
  • Parameters
• sortable
  • Parameters
• sorter
  • Parameters
• keyPrefixStore
  • Parameters## AttributeDefinitionType: Object### Properties* type string
• writable boolean
• private boolean? should the value be shown
• depends string? name of an attribute we depend on
• additionalAttributes Array<string> extra attributes that are present in case our attribute is set
• description string
• default any? the default value
• set Function? set the value
• get Function? get the value can be used to calculate default values
• env (Array<string> | string)? environment variable use to provide the value## tokensSplit property path into tokens### Parameters* string string ## setAttributeSet Object attribute. The name may be a property path like 'a.b.c'.### Parameters* object Object
• name string
• value any ## getAttributeDeliver attribute value. The name may be a property path like 'a.b.c'.### Parameters* object Object
• name string Returns any value associated with the given property name## getAttributeAndOperatorDeliver attribute value and operator. The name may be a property path like 'a.b.c <='.### Parameters* object Object
• expression string
• getters (optional, default {})Returns [any, string] value associated with the given property name## filterGenerate filter function.### Parameters* filterBy Object?
• getters Object? Returns Function ## PaginationPagination support store. Pages go from 1 ... numberOfPages### Parameters* data
• itemsPerPage (optional, default 20)### pageSet current page#### Parameters* n number ### pageReturns number current page### itemsMeta* deprecated: This is deprecated.### pageNavigationElement* See: @link https://getbootstrap.com/docs/4.0/components/pagination
• See: @link https://a11y-style-guide.com/style-guide/section-navigation.html#kssref-navigation-pagination## initializeServiceWorkerCreate a store holding a service worker### Parameters* script string The URL of the service worker script
• options Object An object containing registration optionsReturns Object store holding the service worker## toggleOrderByDeliver next value in the order by cycle. SORT_NONE -> SORT_ASCENDING -> SORT_DESCENDING -> SORT_NONE ...### Parameters* orderBy string Returns string new order either SORT_NONE, SORT_ASCENDING or SORT_DESCENDING## sortableAdd sortable toggle button to a th node. Synchronizes store value with the nodes "aria-sort" attribute.### Parameters* th Element the header node
• store WritableStore keep in sync with sorting properties## sorterGenerate a sort function for a given sort-by set.### Parameters* sortBy (Object | undefined)?
• getters Object? Returns (Function | undefined) sorter## keyPrefixStoreCreate a derived store where all the object keys are prefixed. { a: 1, b: 2 } -> { foo_a: 1 foo_b: 2 } // prefix: foo_### Parameters* store WriteableStore we derive from
• prefix string for each keyReturns WriteableStore # installWith npm do:shell npm install svelte-common or with yarn```shell yarn add svelte-common