@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
190 lines • 8.58 kB
JavaScript
export const PaginationProperties = {
mode: {
doc: 'if set to `infinity`, then the pagination bar will be now shown and but infinity scrolling will do the content presentation. For more information, check out the [Infinity Scroller](/uilib/components/pagination/infinity-scroller). Defaults to `pagination`.',
type: ['pagination', 'infinity'],
status: 'optional'
},
paginationBarLayout: {
doc: 'The layout of the pagination bar. Defaults to `vertical`.',
type: ['vertical', 'horizontal'],
status: 'optional'
},
children: {
doc: 'the given content can be either a function or a React node, depending on your needs. A function contains several helper functions. More details down below and have a look at the examples in the demos section.',
type: ['React.ReactNode', 'function'],
status: 'optional'
},
align: {
doc: 'define the alignment of the pagination button bar. Can be `center`, `left` or `right`. Defaults to `left`.',
type: ['left', 'center', 'right'],
status: 'optional'
},
startup_page: {
doc: 'the page shown in the very beginning. If `current_page` is set, then it may not make too much sense to set this as well.',
type: ['number', 'string'],
status: 'optional'
},
current_page: {
doc: 'the page shown at the moment the component renders. Defaults to `1`.',
type: ['number', 'string'],
status: 'optional'
},
page_count: {
doc: 'the total pages count. Defaults to `1`.',
type: ['number', 'string'],
status: 'optional'
},
startup_count: {
doc: 'defines how many `infinity` pages should be loaded / shown on the first render. Defaults to `1`.',
type: ['number', 'string'],
status: 'optional'
},
parallel_load_count: {
doc: 'defines how many `infinity` pages should be loaded / shown once the user scrolls down. Defaults to `1`.',
type: ['number', 'string'],
status: 'optional'
},
min_wait_time: {
doc: 'the minimum time to wait, if the infinity scroll was invoked under that time threshold. This prevents not intentional infinity scroll loop calls. Defaults to `400` milliseconds.',
type: ['number', 'string'],
status: 'optional'
},
place_maker_before_content: {
doc: 'if set to `true`, the infinity marker will be placed before the content (on top off). This could potentially have negative side effects. But it depends really on the content if this would make more sense to use instead. Defaults to `false`. This prop is deprecated and will be removed in v11, use `place_marker_before_content` instead.',
type: 'boolean',
status: 'deprecated'
},
place_marker_before_content: {
doc: 'if set to `true`, the infinity marker will be placed before the content (on top off). This could potentially have negative side effects. But it depends really on the content if this would make more sense to use instead. Defaults to `false`.',
type: 'boolean',
status: 'optional'
},
use_load_button: {
doc: 'if set to `true` it will disable the automated infinity scrolling, but shows a load more button at the of the content instead.',
type: 'boolean',
status: 'optional'
},
hide_progress_indicator: {
doc: 'if set to `true` no indicator will be shown.',
type: 'boolean',
status: 'optional'
},
page_element: {
doc: 'by default a `<div>` is used. Set it to any element you have to use. Adds also a class: `dnb-pagination__page` shown.',
type: ['string', 'object', 'React.ReactNode'],
status: 'optional'
},
fallback_element: {
doc: '(infinity mode) is used by the _indicator_, _load more_ bar as well as by the marker. Defaults to a `div`.',
type: ['string', 'object', 'React.ReactNode'],
status: 'optional'
},
indicator_element: {
doc: '(infinity mode) is used by the _indicator_. Falls back to `fallback_element` if not defined.',
type: ['string', 'object', 'React.ReactNode'],
status: 'optional'
},
marker_element: {
doc: '(infinity mode) is used by the internal marker. Falls back to `fallback_element` if not defined.',
type: ['string', 'object', 'React.ReactNode'],
status: 'optional'
},
set_content_handler: {
doc: 'callback function to get the `setContent` handler from the current pagination instance. e.g. `set_content_handler={fn => (...)}`. Use this handler to insert content during infinity mode.',
type: 'function',
status: 'optional'
},
reset_content_handler: {
doc: 'callback function to get the `resetContent` handler from the current pagination instance. e.g. `reset_content_handler={fn => (...)}`. Use this handler to reset all the content. You can set it to `true`, to programmatically reset the content.',
type: 'function',
status: 'optional'
},
reset_pagination_handler: {
doc: 'callback function to get the `resetInfinity` handler from the current pagination instance. e.g. `reset_pagination_handler={fn => (...)}`. Use this handler to reset all the internal states. You can set it to `true`, to programmatically reset the states.',
type: 'function',
status: 'optional'
},
end_infinity_handler: {
doc: 'callback function to get the `endInfinity` handler from the current pagination instance. e.g. `end_infinity_handler={fn => (...)}`. Use this handler to end the infinity scrolling procedure, in case the `page_count` is unknown.',
type: 'function',
status: 'optional'
},
button_title: {
doc: 'The title used in every button shown in the bar. Defaults to `Side %s`.',
type: 'string',
status: 'optional'
},
next_title: {
doc: 'The title used in the next page button. Defaults to `Neste side`.',
type: 'string',
status: 'optional'
},
prev_title: {
doc: 'The title used in the previous page button. Defaults to `Forrige side`.',
type: 'string',
status: 'optional'
},
more_pages: {
doc: 'The title used in the dots. Relevant for screen readers. Defaults to `%s flere sider`.',
type: 'string',
status: 'optional'
},
is_loading_text: {
doc: 'Shown until new content is inserted in to the page. Defaults to `Laster nytt innhold`.',
type: 'string',
status: 'optional'
},
barSpace: {
doc: 'Used to set spacing for the pagination bar. Has to be an object with either: `top`, `right`, `bottom` or `left`. Use spacing values like: `small`, `1rem`, `1` or , `16px`. See property [space](/uilib/layout/space/properties).',
type: 'Various',
status: 'optional'
},
load_button_text: {
doc: 'Used during infinity mode. If `use_load_button` is set to `true`, then a button is show on the bottom. If the `startup_page` is higher than 1. Defaults to `Vis mer innhold`.',
type: 'string',
status: 'optional'
},
loadButton: {
doc: 'Used to set load button text and icon alignment. Accepts a function returning a ReactNode too, so you can replace the button with your own component.',
type: 'Various',
status: 'optional'
},
disabled: {
doc: 'if set to `true`, all pagination bar buttons are disabled.',
type: 'boolean',
status: 'optional'
},
skeleton: {
doc: 'If set to `true`, an overlaying skeleton with animation will be shown.',
type: 'boolean',
status: 'optional'
},
'[Space](/uilib/layout/space/properties)': {
doc: 'Spacing properties like `top` or `bottom` are supported.',
type: ['string', 'object'],
status: 'optional'
}
};
export const PaginationEvents = {
on_change: {
doc: 'will be called for every page change, regardless if the mode is `mode="infinity"` or not. Returns an object with number of useful properties and methods. See below for more details.',
type: 'function',
status: 'optional'
},
on_startup: {
doc: 'Only on **infinity** mode. Will be called once the component is ready for interaction. Returns an object with number of useful properties and methods. See below for more details. **NB:** Will be called again as soon as we reset the content by calling `resetContent()`.',
type: 'function',
status: 'optional'
},
on_load: {
doc: 'Only on **infinity** mode. Will be called on every page interaction, also on the very first interaction. Returns an object with number of useful properties and methods. See below for more details.',
type: 'function',
status: 'optional'
},
on_end: {
doc: 'Only on **infinity** mode. Will be called once `page_count` is reached or `endInfinity` was called.',
type: 'function',
status: 'optional'
}
};
//# sourceMappingURL=PaginationDocs.js.map