@redocly/theme 0.45.2 → 0.45.4

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.
Files changed (12) hide show
  1. package/lib/components/Catalog/CatalogCard.js +2 -2
  2. package/lib/components/Feedback/Feedback.js +2 -1
  3. package/lib/components/Menu/MenuMobile.js +4 -1
  4. package/lib/core/constants/common.d.ts +1 -0
  5. package/lib/core/constants/common.js +2 -1
  6. package/lib/core/types/catalog.d.ts +1 -0
  7. package/package.json +1 -1
  8. package/src/components/Catalog/CatalogCard.tsx +1 -1
  9. package/src/components/Feedback/Feedback.tsx +2 -1
  10. package/src/components/Menu/MenuMobile.tsx +4 -1
  11. package/src/core/constants/common.ts +2 -0
  12. package/src/core/types/catalog.ts +1 -0
package/lib/components/Catalog/CatalogCard.js CHANGED
@@ -37,7 +37,7 @@ const Tag_1 = require("../../components/Tag/Tag");
37
37
  const CatalogHighlight_1 = require("../../components/Catalog/CatalogHighlight");
38
38
  const Button_1 = require("../../components/Button/Button");
39
39
  function CatalogCard({ item }) {
40
- var _a;
40
+ var _a, _b;
41
41
  const { useTelemetry } = (0, hooks_1.useThemeHooks)();
42
42
  const telemetry = useTelemetry();
43
43
  return (React.createElement(Link_1.Link, { key: item.docsLink || item.link, to: item.docsLink || item.link },
@@ -47,7 +47,7 @@ function CatalogCard({ item }) {
47
47
  React.createElement(CardTitle, null,
48
48
  React.createElement(CatalogHighlight_1.CatalogHighlight, null, item.title))),
49
49
  React.createElement(CardDescription, null,
50
- React.createElement(CatalogHighlight_1.CatalogHighlight, null, (_a = item.description) !== null && _a !== void 0 ? _a : ''))),
50
+ React.createElement(CatalogHighlight_1.CatalogHighlight, null, (_b = (_a = item.summary) !== null && _a !== void 0 ? _a : item.description) !== null && _b !== void 0 ? _b : ''))),
51
51
  React.createElement(CardFooter, null,
52
52
  React.createElement(CardTags, null,
53
53
  (item.tags || []).map((tag, index) => (React.createElement(CardTag, { key: tag + index, color: (0, utils_1.slug)(tag) },
package/lib/components/Feedback/Feedback.js CHANGED
@@ -36,6 +36,7 @@ const Sentiment_1 = require("../../components/Feedback/Sentiment");
36
36
  const Comment_1 = require("../../components/Feedback/Comment");
37
37
  const Mood_1 = require("../../components/Feedback/Mood");
38
38
  const Scale_1 = require("../../components/Feedback/Scale");
39
+ const constants_1 = require("../../core/constants");
39
40
  const feedbackComponents = {
40
41
  rating: Rating_1.Rating,
41
42
  sentiment: Sentiment_1.Sentiment,
@@ -50,7 +51,7 @@ function Feedback(props) {
50
51
  const telemetry = useTelemetry();
51
52
  const { pathname } = (0, react_router_dom_1.useLocation)();
52
53
  const { feedback: themeFeedbackConf } = (0, hooks_1.useThemeConfig)();
53
- const feedbackConf = Object.assign(Object.assign({}, themeFeedbackConf), { path: props === null || props === void 0 ? void 0 : props.path, type: (props === null || props === void 0 ? void 0 : props.type) || (themeFeedbackConf === null || themeFeedbackConf === void 0 ? void 0 : themeFeedbackConf.type), settings: (props === null || props === void 0 ? void 0 : props.settings) || (themeFeedbackConf === null || themeFeedbackConf === void 0 ? void 0 : themeFeedbackConf.settings) || {}, hide: (_a = props.hide) !== null && _a !== void 0 ? _a : themeFeedbackConf === null || themeFeedbackConf === void 0 ? void 0 : themeFeedbackConf.hide });
54
+ const feedbackConf = Object.assign(Object.assign({}, themeFeedbackConf), { path: props === null || props === void 0 ? void 0 : props.path, type: (props === null || props === void 0 ? void 0 : props.type) || (themeFeedbackConf === null || themeFeedbackConf === void 0 ? void 0 : themeFeedbackConf.type) || constants_1.DEFAULT_FEEDBACK_TYPE, settings: (props === null || props === void 0 ? void 0 : props.settings) || (themeFeedbackConf === null || themeFeedbackConf === void 0 ? void 0 : themeFeedbackConf.settings) || {}, hide: (_a = props.hide) !== null && _a !== void 0 ? _a : themeFeedbackConf === null || themeFeedbackConf === void 0 ? void 0 : themeFeedbackConf.hide });
54
55
  if (feedbackConf.hide) {
55
56
  return null;
56
57
  }
package/lib/components/Menu/MenuMobile.js CHANGED
@@ -58,7 +58,10 @@ function MenuMobile({ className, hideUserProfile }) {
58
58
  return (react_1.default.createElement(MobileMenuWrapper, { "data-component-name": "Menu/MenuMobile", className: className },
59
59
  react_1.default.createElement(ScrollableArea, { isButtonsSectionVisible: !!isButtonsSectionVisible },
60
60
  isButtonsSectionVisible && (react_1.default.createElement(ButtonsSection, { alignRight: !prevLevelName && !!nextLevelName },
61
- prevLevelName && (react_1.default.createElement(ControlButton, { "data-testid": "control-button", onClick: () => setMenuLevel(menuLevel - 1) },
61
+ prevLevelName && (react_1.default.createElement(ControlButton, { "data-testid": "control-button", onClick: () => {
62
+ setMenuLevel(menuLevel - 1);
63
+ popDrilldownState();
64
+ } },
62
65
  react_1.default.createElement(ChevronLeftIcon_1.ChevronLeftIcon, { size: "12px", color: "--tree-content-color-default" }),
63
66
  react_1.default.createElement(ControlButtonLabel, { paddingDirection: "left" }, prevLevelName))),
64
67
  nextLevelName && (react_1.default.createElement(ControlButton, { "data-testid": "control-button", onClick: () => setMenuLevel(menuLevel + 1) },
package/lib/core/constants/common.d.ts CHANGED
@@ -8,6 +8,7 @@ export declare enum FEEDBACK_TYPES {
8
8
  PROBLEM = "problem",
9
9
  SCALE = "scale"
10
10
  }
11
+ export declare const DEFAULT_FEEDBACK_TYPE = FEEDBACK_TYPES.SENTIMENT;
11
12
  export declare enum MenuItemType {
12
13
  Separator = "separator",
13
14
  DrillDown = "drilldown",
package/lib/core/constants/common.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MobileMenuType = exports.MenuItemType = exports.FEEDBACK_TYPES = exports.DEFAULT_LOCALE_PLACEHOLDER = exports.REDOCLY_TEAMS_RBAC = void 0;
3
+ exports.MobileMenuType = exports.MenuItemType = exports.DEFAULT_FEEDBACK_TYPE = exports.FEEDBACK_TYPES = exports.DEFAULT_LOCALE_PLACEHOLDER = exports.REDOCLY_TEAMS_RBAC = void 0;
4
4
  var config_1 = require("@redocly/config");
5
5
  Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return config_1.REDOCLY_TEAMS_RBAC; } });
6
6
  exports.DEFAULT_LOCALE_PLACEHOLDER = 'default_locale';
@@ -13,6 +13,7 @@ var FEEDBACK_TYPES;
13
13
  FEEDBACK_TYPES["PROBLEM"] = "problem";
14
14
  FEEDBACK_TYPES["SCALE"] = "scale";
15
15
  })(FEEDBACK_TYPES || (exports.FEEDBACK_TYPES = FEEDBACK_TYPES = {}));
16
+ exports.DEFAULT_FEEDBACK_TYPE = FEEDBACK_TYPES.SENTIMENT;
16
17
  var MenuItemType;
17
18
  (function (MenuItemType) {
18
19
  MenuItemType["Separator"] = "separator";
package/lib/core/types/catalog.d.ts CHANGED
@@ -28,6 +28,7 @@ export type ResolvedFilter = Omit<CatalogFilterConfig, 'options'> & {
28
28
  export type CatalogItem = {
29
29
  title: string;
30
30
  link: string;
31
+ summary?: string;
31
32
  description?: string;
32
33
  image?: string;
33
34
  docsLink?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/theme",
3
- "version": "0.45.2",
3
+ "version": "0.45.4",
4
4
  "description": "Shared UI components lib",
5
5
  "keywords": [
6
6
  "theme",
package/src/components/Catalog/CatalogCard.tsx CHANGED
@@ -31,7 +31,7 @@ export function CatalogCard({ item }: CatalogCardProps): JSX.Element {
31
31
  </CardTitle>
32
32
  </CardTitleWrapper>
33
33
  <CardDescription>
34
- <CatalogHighlight>{item.description ?? ''}</CatalogHighlight>
34
+ <CatalogHighlight>{item.summary ?? item.description ?? ''}</CatalogHighlight>
35
35
  </CardDescription>
36
36
  </CardContent>
37
37
  <CardFooter>
package/src/components/Feedback/Feedback.tsx CHANGED
@@ -10,6 +10,7 @@ import { Sentiment } from '@redocly/theme/components/Feedback/Sentiment';
10
10
  import { Comment } from '@redocly/theme/components/Feedback/Comment';
11
11
  import { Mood } from '@redocly/theme/components/Feedback/Mood';
12
12
  import { Scale } from '@redocly/theme/components/Feedback/Scale';
13
+ import { DEFAULT_FEEDBACK_TYPE } from '@redocly/theme/core/constants';
13
14
 
14
15
  const feedbackComponents = {
15
16
  rating: Rating,
@@ -31,7 +32,7 @@ export function Feedback(props: FeedbackProps & { path?: string }) {
31
32
  const feedbackConf = {
32
33
  ...themeFeedbackConf,
33
34
  path: props?.path,
34
- type: props?.type || themeFeedbackConf?.type,
35
+ type: props?.type || themeFeedbackConf?.type || DEFAULT_FEEDBACK_TYPE,
35
36
  settings: props?.settings || themeFeedbackConf?.settings || {},
36
37
  hide: props.hide ?? themeFeedbackConf?.hide,
37
38
  };
package/src/components/Menu/MenuMobile.tsx CHANGED
@@ -52,7 +52,10 @@ export function MenuMobile({ className, hideUserProfile }: MobileMenuProps): JSX
52
52
  {prevLevelName && (
53
53
  <ControlButton
54
54
  data-testid="control-button"
55
- onClick={() => setMenuLevel(menuLevel - 1)}
55
+ onClick={() => {
56
+ setMenuLevel(menuLevel - 1);
57
+ popDrilldownState();
58
+ }}
56
59
  >
57
60
  <ChevronLeftIcon size="12px" color="--tree-content-color-default" />
58
61
  <ControlButtonLabel paddingDirection="left">{prevLevelName}</ControlButtonLabel>
package/src/core/constants/common.ts CHANGED
@@ -10,6 +10,8 @@ export enum FEEDBACK_TYPES {
10
10
  SCALE = 'scale',
11
11
  }
12
12
 
13
+ export const DEFAULT_FEEDBACK_TYPE = FEEDBACK_TYPES.SENTIMENT;
14
+
13
15
  export enum MenuItemType {
14
16
  Separator = 'separator',
15
17
  DrillDown = 'drilldown',
package/src/core/types/catalog.ts CHANGED
@@ -25,6 +25,7 @@ export type ResolvedFilter = Omit<CatalogFilterConfig, 'options'> & {
25
25
  export type CatalogItem = {
26
26
  title: string;
27
27
  link: string;
28
+ summary?: string;
28
29
  description?: string;
29
30
  image?: string;
30
31
  docsLink?: string;