@dnb/eufemia 9.15.2 → 9.16.3

package/components/pagination/Pagination.d.ts

@@ -80,6 +80,8 @@ export type PaginationChildren =
  * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
  */
 export interface PaginationProps extends React.HTMLProps<HTMLElement> {
+  debug?: boolean;
+
   /**
    * The page show in the very beginning. If `current_page` is set, then it may not make too much sense to set this as well.
    */
@@ -275,6 +277,286 @@ export default class Pagination extends React.Component<
   static defaultProps: object;
   render(): JSX.Element;
 }
+export type PaginationInstanceStartupPage = string | number;
+export type PaginationInstanceCurrentPage = string | number;
+export type PaginationInstancePageCount = string | number;
+export type PaginationInstanceStartupCount = string | number;
+export type PaginationInstanceParallelLoadCount = string | number;
+export type PaginationInstancePlaceMakerBeforeContent = string | boolean;
+export type PaginationInstanceMinWaitTime = string | number;
+export type PaginationInstanceDisabled = string | boolean;
+export type PaginationInstanceSkeleton = string | boolean;
+export type PaginationInstanceMode = 'pagination' | 'infinity';
+export type PaginationInstanceUseLoadButton = string | boolean;
+export type PaginationInstanceItems = string | any[];
+export type PaginationInstanceHideProgressIndicator = string | boolean;
+export type PaginationInstanceSetContentHandler =
+  | string
+  | ((...args: any[]) => any);
+export type PaginationInstanceResetContentHandler =
+  | string
+  | ((...args: any[]) => any);
+export type PaginationInstanceResetPaginationHandler =
+  | string
+  | ((...args: any[]) => any);
+export type PaginationInstanceEndInfinityHandler =
+  | string
+  | ((...args: any[]) => any);
+export type PaginationInstancePageElement =
+  | Object
+  | React.ReactNode
+  | ((...args: any[]) => any)
+  | string;
+export type PaginationInstanceFallbackElement =
+  | Object
+  | React.ReactNode
+  | ((...args: any[]) => any)
+  | string;
+export type PaginationInstanceMarkerElement =
+  | Object
+  | React.ReactNode
+  | ((...args: any[]) => any)
+  | string;
+export type PaginationInstanceIndicatorElement =
+  | React.ReactNode
+  | ((...args: any[]) => any)
+  | string;
+export type PaginationInstanceSpace =
+  | string
+  | number
+  | boolean
+  | {
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. Will use `margin-top`.
+       */
+      top?: string | number | boolean;
+
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-right`.
+       */
+      right?: string | number | boolean;
+
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-bottom`.
+       */
+      bottom?: string | number | boolean;
+
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-left`.
+       */
+      left?: string | number | boolean;
+    };
+export type PaginationInstanceTop = string | number | boolean;
+export type PaginationInstanceRight = string | number | boolean;
+export type PaginationInstanceBottom = string | number | boolean;
+export type PaginationInstanceLeft = string | number | boolean;
+export type PaginationInstanceChildren =
+  | React.ReactNode
+  | ((...args: any[]) => any);
+
+/**
+ * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
+ */
+export interface PaginationInstanceProps {
+  debug?: boolean;
+
+  /**
+   * The page show in the very beginning. If `current_page` is set, then it may not make too much sense to set this as well.
+   */
+  startup_page?: PaginationInstanceStartupPage;
+
+  /**
+   * The page show in the moment the component renders. Defaults to `1`.
+   */
+  current_page?: PaginationInstanceCurrentPage;
+
+  /**
+   * The total pages count. Defaults to `1`.
+   */
+  page_count?: PaginationInstancePageCount;
+
+  /**
+   * Defines how many `infinity` pages should be loaded / show on the first render. Defaults to `1`.
+   */
+  startup_count?: PaginationInstanceStartupCount;
+
+  /**
+   * Defines how many `infinity` pages should be loaded / show once the users scrolls down. Defaults to `1`.
+   */
+  parallel_load_count?: PaginationInstanceParallelLoadCount;
+
+  /**
+   * If set to `true`, the infinity marker will be placed before the content (on top off). This could potentially have negative side effect. But it depends really on the content, if this would make more sense to use instead. Defaults to `false`.
+   */
+  place_maker_before_content?: PaginationInstancePlaceMakerBeforeContent;
+
+  /**
+   * 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.
+   */
+  min_wait_time?: PaginationInstanceMinWaitTime;
+
+  /**
+   * If set to `true`, all pagination bar buttons are disabled.
+   */
+  disabled?: PaginationInstanceDisabled;
+
+  /**
+   * If set to `true`, an overlaying skeleton with animation will be shown.
+   */
+  skeleton?: PaginationInstanceSkeleton;
+
+  /**
+   * If set to `infinity`, then the pagination bar will be now shown and but infinity scrolling will do the content presentation. Defaults to `pagination`.
+   */
+  mode?: PaginationInstanceMode;
+
+  /**
+   * If set to `true` it will disable the automated infinity scrolling, but shows a load more button at the of the content instead.
+   */
+  use_load_button?: PaginationInstanceUseLoadButton;
+  items?: PaginationInstanceItems;
+
+  /**
+   * If set to `true` no indicator will be shown.
+   */
+  hide_progress_indicator?: PaginationInstanceHideProgressIndicator;
+
+  /**
+   * 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.
+   */
+  set_content_handler?: PaginationInstanceSetContentHandler;
+
+  /**
+   * 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.
+   */
+  reset_content_handler?: PaginationInstanceResetContentHandler;
+
+  /**
+   * 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.
+   */
+  reset_pagination_handler?: PaginationInstanceResetPaginationHandler;
+
+  /**
+   * 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.
+   */
+  end_infinity_handler?: PaginationInstanceEndInfinityHandler;
+
+  /**
+   * By default a `<div>` is used. Set it to what ever element you have to use. Adds also a class: `dnb-pagination__page` shown.
+   */
+  page_element?: PaginationInstancePageElement;
+
+  /**
+   * (infinity mode) is used by the <em>indicator</em>, <em>load more</em> bar as well as by the marker. Defaults to a `div`.
+   */
+  fallback_element?: PaginationInstanceFallbackElement;
+
+  /**
+   * (infinity mode) is used by the internal marker. Falls back to `fallback_element` if not defined.
+   */
+  marker_element?: PaginationInstanceMarkerElement;
+
+  /**
+   * (infinity mode) is used by the <em>indicator</em>. Falls back to `fallback_element` if not defined.
+   */
+  indicator_element?: PaginationInstanceIndicatorElement;
+
+  /**
+   * Define the aligned of the pagination button bar. Can be `center`, `left` or `right`. Defaults to `left`.
+   */
+  align?: string;
+
+  /**
+   * The title used in every button shown in the bar. Defaults to `Side %s`.
+   */
+  button_title?: string;
+
+  /**
+   * The title used in the previous page button. Defaults to `Forrige side`.
+   */
+  prev_title?: string;
+
+  /**
+   * The title used in the next page button. Defaults to `Neste side`.
+   */
+  next_title?: string;
+
+  /**
+   * The title used in the dots. Relevant for screen-readers. Defaults to `%s flere sider`.
+   */
+  more_pages?: string;
+
+  /**
+   * Shown until new content is inserted in to the page. Defaults to `Laster nytt innhold`.
+   */
+  is_loading_text?: string;
+
+  /**
+   * 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`.
+   */
+  load_button_text?: string;
+
+  /**
+   * Has to be an object with either: `top`, `right`, `bottom` or `left`. Use spacing values like: `small`, `1rem`, `1` or , `16px`.
+   */
+  space?: PaginationInstanceSpace;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. Will use `margin-top`.
+   */
+  top?: PaginationInstanceTop;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-right`.
+   */
+  right?: PaginationInstanceRight;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-bottom`.
+   */
+  bottom?: PaginationInstanceBottom;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-left`.
+   */
+  left?: PaginationInstanceLeft;
+  class?: string;
+  className?: string;
+
+  /**
+   * 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.
+   */
+  children?: PaginationInstanceChildren;
+
+  /**
+   * 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. Se below for more details.
+   */
+  on_change?: (...args: any[]) => any;
+
+  /**
+   * Only on "infinity" mode. Will be called once the component is ready for interaction. Returns an object with number of useful properties and methods. Se below for more details. "NB:" Will be called again as soon as we reset the content by calling `resetContent()`.
+   */
+  on_startup?: (...args: any[]) => any;
+
+  /**
+   * 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. Se below for more details.
+   */
+  on_load?: (...args: any[]) => any;
+
+  /**
+   * Only on "infinity" mode. Will be called once `page_count` is reached or `endInfinity` was called.
+   */
+  on_end?: (...args: any[]) => any;
+}
+
+declare class PaginationInstance extends React.Component<
+  PaginationInstanceProps,
+  any
+> {
+  static defaultProps: object;
+  render(): JSX.Element;
+}
+
 export type InfinityMarkerStartupPage = string | number;
 export type InfinityMarkerCurrentPage = string | number;
 export type InfinityMarkerPageCount = string | number;
@@ -356,6 +638,8 @@ export type InfinityMarkerChildren =
  * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
  */
 export interface InfinityMarkerProps {
+  debug?: boolean;
+
   /**
    * The page show in the very beginning. If `current_page` is set, then it may not make too much sense to set this as well.
    */
@@ -551,3 +835,17 @@ export class InfinityMarker extends React.Component<
   static defaultProps: object;
   render(): JSX.Element;
 }
+export type PaginationContentChildren =
+  | React.ReactNode
+  | ((...args: any[]) => any);
+
+/**
+ * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
+ */
+export interface PaginationContentProps {
+  /**
+   * 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.
+   */
+  children: PaginationContentChildren;
+}
+declare const PaginationContent: React.FC<PaginationContentProps>;

package/components/pagination/Pagination.js

@@ -20,6 +20,7 @@ var _excluded = ["align", "children", "className", "class", "disabled", "skeleto
     _excluded2 = ["children"],
     _excluded3 = ["children"];
 import "core-js/modules/es.array.find.js";
+import "core-js/modules/es.object.to-string.js";
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
@@ -40,6 +41,7 @@ import { PaginationIndicator } from './PaginationHelpers';
 import InfinityScroller from './PaginationInfinity';
 import PaginationBar from './PaginationBar';
 var paginationPropTypes = process.env.NODE_ENV !== "production" ? _objectSpread(_objectSpread({
+  debug: PropTypes.bool,
   startup_page: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   current_page: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   page_count: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
@@ -78,6 +80,7 @@ var paginationPropTypes = process.env.NODE_ENV !== "production" ? _objectSpread(
   on_end: PropTypes.func
 }) : {};
 var paginationDefaultProps = {
+  debug: null,
   startup_page: null,
   current_page: null,
   page_count: null,

package/components/pagination/PaginationBar.js

@@ -1,3 +1,4 @@
+import "core-js/modules/es.object.to-string.js";
 import "core-js/modules/es.reflect.construct.js";
 import "core-js/modules/es.object.keys.js";
 import "core-js/modules/es.symbol.js";
@@ -96,7 +97,7 @@ var PaginationBar = function (_React$PureComponent) {
     key: "componentDidMount",
     value: function componentDidMount() {
       var context = this.context.pagination;
-      var currentPage = context.startupPage || context.currentPage;
+      var currentPage = context.startupPage || context.currentPage || 1;
       var items = context.prefillItems(currentPage, {
         skipObserver: true
       });

package/components/pagination/PaginationHelpers.js

@@ -1,3 +1,4 @@
+import "core-js/modules/es.object.to-string.js";
 import "core-js/modules/es.reflect.construct.js";
 import "core-js/modules/es.object.keys.js";
 import "core-js/modules/es.symbol.js";