@diplodoc/tabs-extension 3.6.1 → 3.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -1
- package/build/react/TabsRuntime.d.ts +4 -0
- package/build/react/index.d.ts +1 -0
- package/build/react/index.js +32 -0
- package/build/react/index.js.map +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -138,7 +138,26 @@ You can set your own keys for tabs with this statement:
|
|
|
138
138
|
{% endlist %}
|
|
139
139
|
```
|
|
140
140
|
|
|
141
|
-
## React
|
|
141
|
+
## React component for easy installation
|
|
142
|
+
|
|
143
|
+
```tsx
|
|
144
|
+
import {TabsRuntime} from '@diplodoc/tabs-extension/react';
|
|
145
|
+
|
|
146
|
+
// ...
|
|
147
|
+
render() {
|
|
148
|
+
return (
|
|
149
|
+
<>
|
|
150
|
+
<TabsRuntime
|
|
151
|
+
saveTabsToLocalStorage={true}
|
|
152
|
+
saveTabsToQueryStateMode='page'
|
|
153
|
+
router={router} // optional
|
|
154
|
+
/>
|
|
155
|
+
</>
|
|
156
|
+
);
|
|
157
|
+
}
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Or you can use React hook for smart control
|
|
142
161
|
|
|
143
162
|
You can use the React hook to handle active tab changing or to select opened tabs programmatically.
|
|
144
163
|
|
|
@@ -225,3 +244,7 @@ export const App: React.FC = () => {
|
|
|
225
244
|
);
|
|
226
245
|
}
|
|
227
246
|
```
|
|
247
|
+
|
|
248
|
+
## For contributors
|
|
249
|
+
|
|
250
|
+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
package/build/react/index.d.ts
CHANGED
package/build/react/index.js
CHANGED
|
@@ -2,7 +2,21 @@
|
|
|
2
2
|
var __defProp = Object.defineProperty;
|
|
3
3
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
4
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __getOwnPropSymbols = Object.getOwnPropertySymbols;
|
|
5
6
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
7
|
+
var __propIsEnum = Object.prototype.propertyIsEnumerable;
|
|
8
|
+
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
9
|
+
var __spreadValues = (a, b) => {
|
|
10
|
+
for (var prop in b || (b = {}))
|
|
11
|
+
if (__hasOwnProp.call(b, prop))
|
|
12
|
+
__defNormalProp(a, prop, b[prop]);
|
|
13
|
+
if (__getOwnPropSymbols)
|
|
14
|
+
for (var prop of __getOwnPropSymbols(b)) {
|
|
15
|
+
if (__propIsEnum.call(b, prop))
|
|
16
|
+
__defNormalProp(a, prop, b[prop]);
|
|
17
|
+
}
|
|
18
|
+
return a;
|
|
19
|
+
};
|
|
6
20
|
var __export = (target, all) => {
|
|
7
21
|
for (var name in all)
|
|
8
22
|
__defProp(target, name, { get: all[name], enumerable: true });
|
|
@@ -20,6 +34,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
20
34
|
// src/react/index.ts
|
|
21
35
|
var react_exports = {};
|
|
22
36
|
__export(react_exports, {
|
|
37
|
+
TabsRuntime: () => TabsRuntime,
|
|
23
38
|
useDiplodocTabs: () => useDiplodocTabs
|
|
24
39
|
});
|
|
25
40
|
module.exports = __toCommonJS(react_exports);
|
|
@@ -78,4 +93,21 @@ function useDiplodocTabs(callback = void 0) {
|
|
|
78
93
|
)
|
|
79
94
|
};
|
|
80
95
|
}
|
|
96
|
+
|
|
97
|
+
// src/react/TabsRuntime.ts
|
|
98
|
+
var import_react2 = require("react");
|
|
99
|
+
function TabsRuntime(props = {}) {
|
|
100
|
+
if (typeof window === "undefined") {
|
|
101
|
+
return null;
|
|
102
|
+
}
|
|
103
|
+
const tabs = useDiplodocTabs();
|
|
104
|
+
(0, import_react2.useEffect)(() => {
|
|
105
|
+
tabs.configure(__spreadValues({}, props));
|
|
106
|
+
}, [props, tabs]);
|
|
107
|
+
(0, import_react2.useEffect)(() => {
|
|
108
|
+
tabs.onPageChanged();
|
|
109
|
+
tabs.restoreTabs(__spreadValues(__spreadValues({}, tabs.getTabsFromLocalStorage()), tabs.getTabsFromSearchQuery()));
|
|
110
|
+
}, [props.router]);
|
|
111
|
+
return null;
|
|
112
|
+
}
|
|
81
113
|
//# sourceMappingURL=index.js.map
|
package/build/react/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
|
-
"sources": ["../../src/react/index.ts", "../../src/react/useDiplodocTabs.ts", "../../src/common.ts"],
|
|
4
|
-
"sourcesContent": ["export type {Tab, UseDiplodocTabsCallback} from './useDiplodocTabs';\nexport {useDiplodocTabs} from './useDiplodocTabs';\n", "import {useCallback, useEffect} from 'react';\n\nimport {GLOBAL_SYMBOL, SelectedTabEvent, Tab} from '../common';\nimport {ISelectTabByIdOptions, TabsControllerOptions, TabsHistory} from '../runtime/TabsController';\n\nexport type {Tab};\n\nexport type UseDiplodocTabsCallback = (tab: Tab, currentTabId?: string) => void;\n\nexport function useDiplodocTabs(callback: UseDiplodocTabsCallback | undefined = undefined) {\n if (callback !== undefined) {\n const selectTabHandle = useCallback(\n ({tab, currentTabId}: SelectedTabEvent) => {\n callback(tab, currentTabId);\n },\n [callback],\n );\n\n useEffect(() => window[GLOBAL_SYMBOL].onSelectTab(selectTabHandle), [selectTabHandle]);\n }\n\n return {\n selectTabById: useCallback(\n (tabId: string, options?: ISelectTabByIdOptions) =>\n window[GLOBAL_SYMBOL].selectTabById(tabId, options),\n [],\n ),\n selectTab: useCallback((tab: Tab) => window[GLOBAL_SYMBOL].selectTab(tab), []),\n configure: useCallback(\n (options: Partial<TabsControllerOptions>) => window[GLOBAL_SYMBOL].configure(options),\n [],\n ),\n restoreTabs: useCallback(\n (tabsHistory: TabsHistory) => window[GLOBAL_SYMBOL].restoreTabs(tabsHistory),\n [],\n ),\n onPageChanged: useCallback(() => window[GLOBAL_SYMBOL].onPageChanged(), []),\n getTabsFromLocalStorage: useCallback(\n () => window[GLOBAL_SYMBOL].getTabsFromLocalStorage(),\n [],\n ),\n getTabsFromSearchQuery: useCallback(\n () => window[GLOBAL_SYMBOL].getTabsFromSearchQuery(),\n [],\n ),\n getCurrentPageTabHistory: useCallback(\n (tabsHistory: TabsHistory) =>\n window[GLOBAL_SYMBOL].getCurrentPageTabHistory(tabsHistory),\n [],\n ),\n updateLocalStorageWithTabs: useCallback(\n (tabsHistory: TabsHistory) =>\n window[GLOBAL_SYMBOL].updateLocalStorageWithTabs(tabsHistory),\n [],\n ),\n updateQueryParamWithTabs: useCallback(\n (tabsHistory: TabsHistory) =>\n window[GLOBAL_SYMBOL].updateQueryParamWithTabs(tabsHistory),\n [],\n ),\n };\n}\n", "import {type TabsController} from './runtime/TabsController';\n\nexport const TAB_RE = /`?{% list tabs .*?%}`?/;\nexport const TABS_CLASSNAME = 'yfm-tabs';\nexport const TAB_CLASSNAME = 'yfm-tab';\nexport const TAB_PANEL_CLASSNAME = 'yfm-tab-panel';\nexport const TABS_LIST_CLASSNAME = 'yfm-tab-list';\nexport const ACTIVE_CLASSNAME = 'active';\nexport const TAB_GROUP_CLASSNAME = 'yfm-tab-group';\nexport const TAB_ACTIVE_KEY = 'data-diplodoc-is-active';\nexport const GROUP_DATA_KEY = 'data-diplodoc-group';\nexport const TAB_DATA_KEY = 'data-diplodoc-key';\nexport const TAB_DATA_VARIANT = 'data-diplodoc-variant';\nexport const TAB_DATA_ID = 'data-diplodoc-id';\nexport const DEFAULT_TABS_GROUP_PREFIX = 'defaultTabsGroup-';\nexport const ACTIVE_TAB_TEXT = '{selected}';\nexport const TAB_FORCED_OPEN = 'data-diplodoc-forced';\n\nexport const TABS_DROPDOWN_CLASSNAME = 'yfm-tabs-dropdown';\nexport const TABS_DROPDOWN_MENU_CLASSNAME = 'yfm-tabs-dropdown-menu';\nexport const TABS_DROPDOWN_SELECT = 'yfm-tabs-dropdown-select';\n\nexport const TABS_ACCORDION_CLASSNAME = 'yfm-tabs-accordion';\nexport const TABS_ACCORDION_CLIENT_HEIGHT = 'data-yfm-tabs-accordion-client-heights';\n\nexport const TABS_RADIO_CLASSNAME = 'yfm-tabs-vertical';\nexport const VERTICAL_TAB_CLASSNAME = 'yfm-vertical-tab';\nexport const TAB_DATA_VERTICAL_TAB = 'data-diplodoc-vertical-tab';\nexport const TAB_RADIO_KEY = 'data-diplodoc-input';\n\nexport enum TabsVariants {\n Regular = 'regular',\n Radio = 'radio',\n Dropdown = 'dropdown',\n Accordion = 'accordion',\n}\n\nexport type EnabledVariants = Partial<Record<TabsVariants, boolean>>;\n\nexport interface Tab {\n group?: string;\n key: string;\n variant: TabsVariants;\n}\n\nexport interface SelectedTabEvent {\n tab: Tab;\n currentTabId?: string;\n}\n\nexport const GLOBAL_SYMBOL: unique symbol = Symbol.for('diplodocTabs');\n\ndeclare global {\n interface Window {\n [GLOBAL_SYMBOL]: TabsController;\n }\n}\n"],
|
|
5
|
-
"mappings": "
|
|
6
|
-
"names": []
|
|
3
|
+
"sources": ["../../src/react/index.ts", "../../src/react/useDiplodocTabs.ts", "../../src/common.ts", "../../src/react/TabsRuntime.ts"],
|
|
4
|
+
"sourcesContent": ["export type {Tab, UseDiplodocTabsCallback} from './useDiplodocTabs';\nexport {useDiplodocTabs} from './useDiplodocTabs';\nexport {TabsRuntime} from './TabsRuntime';\n", "import {useCallback, useEffect} from 'react';\n\nimport {GLOBAL_SYMBOL, SelectedTabEvent, Tab} from '../common';\nimport {ISelectTabByIdOptions, TabsControllerOptions, TabsHistory} from '../runtime/TabsController';\n\nexport type {Tab};\n\nexport type UseDiplodocTabsCallback = (tab: Tab, currentTabId?: string) => void;\n\nexport function useDiplodocTabs(callback: UseDiplodocTabsCallback | undefined = undefined) {\n if (callback !== undefined) {\n const selectTabHandle = useCallback(\n ({tab, currentTabId}: SelectedTabEvent) => {\n callback(tab, currentTabId);\n },\n [callback],\n );\n\n useEffect(() => window[GLOBAL_SYMBOL].onSelectTab(selectTabHandle), [selectTabHandle]);\n }\n\n return {\n selectTabById: useCallback(\n (tabId: string, options?: ISelectTabByIdOptions) =>\n window[GLOBAL_SYMBOL].selectTabById(tabId, options),\n [],\n ),\n selectTab: useCallback((tab: Tab) => window[GLOBAL_SYMBOL].selectTab(tab), []),\n configure: useCallback(\n (options: Partial<TabsControllerOptions>) => window[GLOBAL_SYMBOL].configure(options),\n [],\n ),\n restoreTabs: useCallback(\n (tabsHistory: TabsHistory) => window[GLOBAL_SYMBOL].restoreTabs(tabsHistory),\n [],\n ),\n onPageChanged: useCallback(() => window[GLOBAL_SYMBOL].onPageChanged(), []),\n getTabsFromLocalStorage: useCallback(\n () => window[GLOBAL_SYMBOL].getTabsFromLocalStorage(),\n [],\n ),\n getTabsFromSearchQuery: useCallback(\n () => window[GLOBAL_SYMBOL].getTabsFromSearchQuery(),\n [],\n ),\n getCurrentPageTabHistory: useCallback(\n (tabsHistory: TabsHistory) =>\n window[GLOBAL_SYMBOL].getCurrentPageTabHistory(tabsHistory),\n [],\n ),\n updateLocalStorageWithTabs: useCallback(\n (tabsHistory: TabsHistory) =>\n window[GLOBAL_SYMBOL].updateLocalStorageWithTabs(tabsHistory),\n [],\n ),\n updateQueryParamWithTabs: useCallback(\n (tabsHistory: TabsHistory) =>\n window[GLOBAL_SYMBOL].updateQueryParamWithTabs(tabsHistory),\n [],\n ),\n };\n}\n", "import {type TabsController} from './runtime/TabsController';\n\nexport const TAB_RE = /`?{% list tabs .*?%}`?/;\nexport const TABS_CLASSNAME = 'yfm-tabs';\nexport const TAB_CLASSNAME = 'yfm-tab';\nexport const TAB_PANEL_CLASSNAME = 'yfm-tab-panel';\nexport const TABS_LIST_CLASSNAME = 'yfm-tab-list';\nexport const ACTIVE_CLASSNAME = 'active';\nexport const TAB_GROUP_CLASSNAME = 'yfm-tab-group';\nexport const TAB_ACTIVE_KEY = 'data-diplodoc-is-active';\nexport const GROUP_DATA_KEY = 'data-diplodoc-group';\nexport const TAB_DATA_KEY = 'data-diplodoc-key';\nexport const TAB_DATA_VARIANT = 'data-diplodoc-variant';\nexport const TAB_DATA_ID = 'data-diplodoc-id';\nexport const DEFAULT_TABS_GROUP_PREFIX = 'defaultTabsGroup-';\nexport const ACTIVE_TAB_TEXT = '{selected}';\nexport const TAB_FORCED_OPEN = 'data-diplodoc-forced';\n\nexport const TABS_DROPDOWN_CLASSNAME = 'yfm-tabs-dropdown';\nexport const TABS_DROPDOWN_MENU_CLASSNAME = 'yfm-tabs-dropdown-menu';\nexport const TABS_DROPDOWN_SELECT = 'yfm-tabs-dropdown-select';\n\nexport const TABS_ACCORDION_CLASSNAME = 'yfm-tabs-accordion';\nexport const TABS_ACCORDION_CLIENT_HEIGHT = 'data-yfm-tabs-accordion-client-heights';\n\nexport const TABS_RADIO_CLASSNAME = 'yfm-tabs-vertical';\nexport const VERTICAL_TAB_CLASSNAME = 'yfm-vertical-tab';\nexport const TAB_DATA_VERTICAL_TAB = 'data-diplodoc-vertical-tab';\nexport const TAB_RADIO_KEY = 'data-diplodoc-input';\n\nexport enum TabsVariants {\n Regular = 'regular',\n Radio = 'radio',\n Dropdown = 'dropdown',\n Accordion = 'accordion',\n}\n\nexport type EnabledVariants = Partial<Record<TabsVariants, boolean>>;\n\nexport interface Tab {\n group?: string;\n key: string;\n variant: TabsVariants;\n}\n\nexport interface SelectedTabEvent {\n tab: Tab;\n currentTabId?: string;\n}\n\nexport const GLOBAL_SYMBOL: unique symbol = Symbol.for('diplodocTabs');\n\ndeclare global {\n interface Window {\n [GLOBAL_SYMBOL]: TabsController;\n }\n}\n", "import {useEffect} from 'react';\n\nimport {TabsControllerOptions} from '../runtime/TabsController';\n\nimport {useDiplodocTabs} from './useDiplodocTabs';\n\nexport function TabsRuntime(props: Partial<TabsControllerOptions> & {router?: object} = {}) {\n if (typeof window === 'undefined') {\n return null;\n }\n\n const tabs = useDiplodocTabs();\n\n useEffect(() => {\n tabs.configure({...props});\n }, [props, tabs]);\n\n useEffect(() => {\n tabs.onPageChanged();\n tabs.restoreTabs({\n ...tabs.getTabsFromLocalStorage(),\n ...tabs.getTabsFromSearchQuery(),\n });\n }, [props.router]);\n\n return null;\n}\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAqC;;;ACkD9B,IAAM,gBAA+B,OAAO,IAAI,cAAc;;;ADzC9D,SAAS,gBAAgB,WAAgD,QAAW;AACvF,MAAI,aAAa,QAAW;AACxB,UAAM,sBAAkB;AAAA,MACpB,CAAC,EAAC,KAAK,aAAY,MAAwB;AACvC,iBAAS,KAAK,YAAY;AAAA,MAC9B;AAAA,MACA,CAAC,QAAQ;AAAA,IACb;AAEA,gCAAU,MAAM,OAAO,aAAa,EAAE,YAAY,eAAe,GAAG,CAAC,eAAe,CAAC;AAAA,EACzF;AAEA,SAAO;AAAA,IACH,mBAAe;AAAA,MACX,CAAC,OAAe,YACZ,OAAO,aAAa,EAAE,cAAc,OAAO,OAAO;AAAA,MACtD,CAAC;AAAA,IACL;AAAA,IACA,eAAW,0BAAY,CAAC,QAAa,OAAO,aAAa,EAAE,UAAU,GAAG,GAAG,CAAC,CAAC;AAAA,IAC7E,eAAW;AAAA,MACP,CAAC,YAA4C,OAAO,aAAa,EAAE,UAAU,OAAO;AAAA,MACpF,CAAC;AAAA,IACL;AAAA,IACA,iBAAa;AAAA,MACT,CAAC,gBAA6B,OAAO,aAAa,EAAE,YAAY,WAAW;AAAA,MAC3E,CAAC;AAAA,IACL;AAAA,IACA,mBAAe,0BAAY,MAAM,OAAO,aAAa,EAAE,cAAc,GAAG,CAAC,CAAC;AAAA,IAC1E,6BAAyB;AAAA,MACrB,MAAM,OAAO,aAAa,EAAE,wBAAwB;AAAA,MACpD,CAAC;AAAA,IACL;AAAA,IACA,4BAAwB;AAAA,MACpB,MAAM,OAAO,aAAa,EAAE,uBAAuB;AAAA,MACnD,CAAC;AAAA,IACL;AAAA,IACA,8BAA0B;AAAA,MACtB,CAAC,gBACG,OAAO,aAAa,EAAE,yBAAyB,WAAW;AAAA,MAC9D,CAAC;AAAA,IACL;AAAA,IACA,gCAA4B;AAAA,MACxB,CAAC,gBACG,OAAO,aAAa,EAAE,2BAA2B,WAAW;AAAA,MAChE,CAAC;AAAA,IACL;AAAA,IACA,8BAA0B;AAAA,MACtB,CAAC,gBACG,OAAO,aAAa,EAAE,yBAAyB,WAAW;AAAA,MAC9D,CAAC;AAAA,IACL;AAAA,EACJ;AACJ;;;AE7DA,IAAAA,gBAAwB;AAMjB,SAAS,YAAY,QAA4D,CAAC,GAAG;AACxF,MAAI,OAAO,WAAW,aAAa;AAC/B,WAAO;AAAA,EACX;AAEA,QAAM,OAAO,gBAAgB;AAE7B,+BAAU,MAAM;AACZ,SAAK,UAAU,mBAAI,MAAM;AAAA,EAC7B,GAAG,CAAC,OAAO,IAAI,CAAC;AAEhB,+BAAU,MAAM;AACZ,SAAK,cAAc;AACnB,SAAK,YAAY,kCACV,KAAK,wBAAwB,IAC7B,KAAK,uBAAuB,EAClC;AAAA,EACL,GAAG,CAAC,MAAM,MAAM,CAAC;AAEjB,SAAO;AACX;",
|
|
6
|
+
"names": ["import_react"]
|
|
7
7
|
}
|