@redocly/theme 0.42.0 → 0.42.2

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.
@@ -9,7 +9,7 @@ export type CardProps = React.PropsWithChildren<{
9
9
  layout?: 'horizontal' | 'vertical' | 'combined';
10
10
  variant?: 'filled' | 'outlined' | 'elevated' | 'ghost';
11
11
  iconVariant?: 'filled' | 'ghost';
12
- align: 'start' | 'center' | 'end';
12
+ align?: 'start' | 'center' | 'end';
13
13
  to?: string;
14
14
  }>;
15
15
  export declare function Card({ title, image, icon, iconRawContent, imagePosition, layout, variant, lineClamp, iconVariant, align, to, children, }: CardProps): React.JSX.Element;
@@ -9,24 +9,24 @@ const styled_components_1 = __importDefault(require("styled-components"));
9
9
  const ChevronRightIcon_1 = require("../../../icons/ChevronRightIcon/ChevronRightIcon");
10
10
  const CardImage_1 = require("../../../markdoc/components/Cards/CardImage");
11
11
  const CardIcon_1 = require("../../../markdoc/components/Cards/CardIcon");
12
+ const Link_1 = require("../../../components/Link/Link");
12
13
  function Card({ title, image, icon, iconRawContent, imagePosition = 'start', layout = 'vertical', variant = 'filled', lineClamp, iconVariant, align = 'start', to, children, }) {
13
14
  const titleNoSpaces = title.replace(/\s+/g, '-').toLowerCase();
14
15
  const cardTitleId = `card-title-${titleNoSpaces}`;
15
- // Get align values
16
16
  const justifyContent = align === 'center' ? 'center' : align === 'end' ? 'flex-end' : 'flex-start';
17
17
  const alignItems = align === 'center' ? 'center' : align === 'end' ? 'flex-end' : 'flex-start';
18
18
  const textAlign = align === 'center' ? 'center' : align === 'end' ? 'right' : 'left';
19
- iconVariant = (iconVariant !== null && iconVariant !== void 0 ? iconVariant : variant === 'ghost') ? 'filled' : 'ghost';
20
- return (react_1.default.createElement(CardWrapper, { as: to ? 'a' : 'div', href: to, "aria-labelledby": cardTitleId, variant: variant, layout: layout, isCardLink: !!to },
19
+ iconVariant = iconVariant !== null && iconVariant !== void 0 ? iconVariant : (variant === 'ghost' ? 'filled' : 'ghost');
20
+ return (react_1.default.createElement(CardWrapper, { as: to ? Link_1.Link : 'div', to: to, "aria-labelledby": cardTitleId, variant: variant, layout: layout, isCardLink: !!to },
21
21
  react_1.default.createElement(react_1.default.Fragment, null,
22
22
  image ? react_1.default.createElement(CardImage_1.CardImage, { src: image, alt: title, position: imagePosition }) : null,
23
23
  react_1.default.createElement(CardContentWrapper, { layout: layout, alignItems: alignItems, textAlign: textAlign, hasImage: image !== undefined },
24
24
  icon && react_1.default.createElement(CardIcon_1.CardIcon, { variant: iconVariant, src: icon, rawContent: iconRawContent }),
25
25
  react_1.default.createElement(ContentWrapper, null,
26
- react_1.default.createElement(Title, { id: cardTitleId, isCardLink: !!to, justifyContent: justifyContent },
26
+ react_1.default.createElement(Title, { id: cardTitleId, "$isCardLink": !!to, "$justifyContent": justifyContent },
27
27
  title,
28
28
  !!to && react_1.default.createElement(CardLinkIcon, null)),
29
- react_1.default.createElement(Body, { lineClamp: lineClamp }, children))))));
29
+ react_1.default.createElement(Body, { "$lineClamp": lineClamp }, children))))));
30
30
  }
31
31
  exports.Card = Card;
32
32
  const CardContentWrapper = styled_components_1.default.div `
@@ -51,7 +51,7 @@ const Title = styled_components_1.default.h3 `
51
51
  color: var(--card-title-text-color);
52
52
  display: flex;
53
53
  align-items: center;
54
- justify-content: ${({ justifyContent }) => justifyContent};
54
+ justify-content: ${({ $justifyContent }) => $justifyContent};
55
55
  width: 100%;
56
56
  `;
57
57
  const CardLinkIcon = (0, styled_components_1.default)(ChevronRightIcon_1.ChevronRightIcon) `
@@ -66,10 +66,10 @@ const Body = styled_components_1.default.div `
66
66
  font-size: var(--card-body-font-size);
67
67
  line-height: var(--card-body-line-height);
68
68
 
69
- ${({ lineClamp }) => lineClamp &&
69
+ ${({ $lineClamp }) => $lineClamp &&
70
70
  `
71
71
  display: -webkit-box;
72
- -webkit-line-clamp: ${lineClamp};
72
+ -webkit-line-clamp: ${$lineClamp};
73
73
  -webkit-box-orient: vertical;
74
74
  overflow: hidden;
75
75
  text-overflow: ellipsis;`}
@@ -104,11 +104,11 @@ const Body = styled_components_1.default.div `
104
104
  fill: var(--link-color-visited);
105
105
  }
106
106
  `;
107
- const CardWrapper = styled_components_1.default.div.attrs(({ isCardLink, variant }) => ({
108
- className: getCardWrapperClass(isCardLink, variant),
107
+ const CardWrapper = styled_components_1.default.div.attrs(({ $isCardLink, $variant }) => ({
108
+ className: getCardWrapperClass($isCardLink, $variant),
109
109
  })) `
110
110
  display: flex;
111
- flex-direction: ${({ layout }) => (layout === 'horizontal' ? 'row' : 'column')};
111
+ flex-direction: ${({ $layout }) => ($layout === 'horizontal' ? 'row' : 'column')};
112
112
  width: 100%;
113
113
  height: 100%;
114
114
  border-radius: var(--card-border-radius);
@@ -125,7 +125,7 @@ const CardWrapper = styled_components_1.default.div.attrs(({ isCardLink, variant
125
125
  box-shadow: var(--card-box-shadow);
126
126
 
127
127
  && > img {
128
- ${({ layout }) => layout === 'horizontal' &&
128
+ ${({ $layout }) => $layout === 'horizontal' &&
129
129
  `
130
130
  max-width: 33%;
131
131
  width: auto;
@@ -155,10 +155,10 @@ const CardWrapper = styled_components_1.default.div.attrs(({ isCardLink, variant
155
155
  margin: var(--spacing-xs) 0;
156
156
  }
157
157
  `;
158
- const getCardWrapperClass = (isCardLink, variant) => {
158
+ const getCardWrapperClass = ($isCardLink, $variant) => {
159
159
  let classes = [];
160
- classes.push(`card-variant-${variant}`);
161
- if (isCardLink) {
160
+ classes.push(`card-variant-${$variant}`);
161
+ if ($isCardLink) {
162
162
  classes.push('card-link');
163
163
  }
164
164
  return classes.join(' ');
@@ -8,7 +8,7 @@ const react_1 = __importDefault(require("react"));
8
8
  const styled_components_1 = __importDefault(require("styled-components"));
9
9
  const InlineSvg_1 = require("../../../markdoc/components/InlineSvg/InlineSvg");
10
10
  function CardIcon({ variant, src, rawContent }) {
11
- return (react_1.default.createElement(CardIconWrapper, { variant: variant }, rawContent ? react_1.default.createElement(CardSvg, { fileRawContent: rawContent }) : react_1.default.createElement(CardImg, { src: src })));
11
+ return (react_1.default.createElement(CardIconWrapper, { "$variant": variant }, rawContent ? react_1.default.createElement(CardSvg, { fileRawContent: rawContent }) : react_1.default.createElement(CardImg, { src: src })));
12
12
  }
13
13
  exports.CardIcon = CardIcon;
14
14
  const CardImg = styled_components_1.default.img `
@@ -36,11 +36,11 @@ const CardIconWrapper = styled_components_1.default.div `
36
36
  min-height: var(--card-icon-height);
37
37
  flex-shrink: 0;
38
38
 
39
- padding: ${({ variant }) => (variant === 'ghost' ? '0' : `var(--card-icon-padding);`)};
39
+ padding: ${({ $variant }) => ($variant === 'ghost' ? '0' : `var(--card-icon-padding);`)};
40
40
  border-radius: var(--card-icon-border-radius);
41
41
  overflow: hidden;
42
42
 
43
- background-color: ${({ variant }) => variant === 'ghost' ? 'transparent' : 'var(--card-icon-bg-color)'};
44
- border: ${({ variant }) => variant === 'ghost' ? 'none' : `1px solid var(--card-icon-border-color)`};
43
+ background-color: ${({ $variant }) => $variant === 'ghost' ? 'transparent' : 'var(--card-icon-bg-color)'};
44
+ border: ${({ $variant }) => $variant === 'ghost' ? 'none' : `1px solid var(--card-icon-border-color)`};
45
45
  `;
46
46
  //# sourceMappingURL=CardIcon.js.map
@@ -7,7 +7,7 @@ exports.CardImage = void 0;
7
7
  const react_1 = __importDefault(require("react"));
8
8
  const styled_components_1 = __importDefault(require("styled-components"));
9
9
  function CardImage({ src, alt, position }) {
10
- return react_1.default.createElement(Image, { src: src, alt: alt, position: position });
10
+ return react_1.default.createElement(Image, { src: src, alt: alt, "$position": position });
11
11
  }
12
12
  exports.CardImage = CardImage;
13
13
  const Image = styled_components_1.default.img `
@@ -16,6 +16,6 @@ const Image = styled_components_1.default.img `
16
16
  flex-shrink: 0;
17
17
  object-fit: cover;
18
18
 
19
- order: ${({ position }) => (position === 'end' ? 1 : 0)};
19
+ order: ${({ $position }) => ($position === 'end' ? 1 : 0)};
20
20
  `;
21
21
  //# sourceMappingURL=CardImage.js.map
@@ -30,15 +30,21 @@ exports.Cards = void 0;
30
30
  const React = __importStar(require("react"));
31
31
  const styled_components_1 = __importDefault(require("styled-components"));
32
32
  function Cards({ cardMinWidth = 240, columns, className, children, ariaLabel }) {
33
- return (React.createElement(GridLayout, { cardMinWidth: cardMinWidth, columns: columns, className: className, "aria-label": ariaLabel }, children));
33
+ return (React.createElement(GridLayout, { "$cardMinWidth": cardMinWidth, "$columns": columns, className: className, "aria-label": ariaLabel }, children));
34
34
  }
35
35
  exports.Cards = Cards;
36
36
  const GridLayout = styled_components_1.default.div `
37
37
  display: grid;
38
- grid-template-columns: ${({ cardMinWidth, columns }) => `repeat(${columns || 'auto-fit'}, minmax(${cardMinWidth}px, 1fr))`};
38
+ grid-template-columns: ${({ $cardMinWidth, $columns }) => `repeat(auto-fit, minmax(${getCardMinWidth($cardMinWidth, $columns)}, 1fr))`};
39
39
  gap: var(--cards-gap);
40
40
  width: 100%;
41
41
  margin-top: var(--spacing-base);
42
42
  margin-bottom: var(--spacing-base);
43
43
  `;
44
+ function getColumnWidth(columns) {
45
+ return `calc((100% - ${columns - 1} * var(--cards-gap)) / ${columns})`;
46
+ }
47
+ function getCardMinWidth(cardMinWidth, columns) {
48
+ return columns ? `max(${getColumnWidth(columns)}, ${cardMinWidth}px)` : `${cardMinWidth}px`;
49
+ }
44
50
  //# sourceMappingURL=Cards.js.map
@@ -47,7 +47,7 @@ exports.card = {
47
47
  type: String,
48
48
  matches: ['filled', 'ghost'],
49
49
  },
50
- to: { type: String },
50
+ to: { type: String, resolver: 'link' },
51
51
  },
52
52
  children: ['paragraph', 'tag', 'list'],
53
53
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/theme",
3
- "version": "0.42.0",
3
+ "version": "0.42.2",
4
4
  "description": "Shared UI components lib",
5
5
  "keywords": [
6
6
  "theme",
@@ -4,6 +4,7 @@ import styled from 'styled-components';
4
4
  import { ChevronRightIcon } from '@redocly/theme/icons/ChevronRightIcon/ChevronRightIcon';
5
5
  import { CardImage } from '@redocly/theme/markdoc/components/Cards/CardImage';
6
6
  import { CardIcon } from '@redocly/theme/markdoc/components/Cards/CardIcon';
7
+ import { Link } from '@redocly/theme/components/Link/Link';
7
8
 
8
9
  export type CardProps = React.PropsWithChildren<{
9
10
  title: string;
@@ -15,7 +16,7 @@ export type CardProps = React.PropsWithChildren<{
15
16
  layout?: 'horizontal' | 'vertical' | 'combined';
16
17
  variant?: 'filled' | 'outlined' | 'elevated' | 'ghost';
17
18
  iconVariant?: 'filled' | 'ghost';
18
- align: 'start' | 'center' | 'end';
19
+ align?: 'start' | 'center' | 'end';
19
20
  to?: string;
20
21
  }>;
21
22
 
@@ -35,17 +36,16 @@ export function Card({
35
36
  }: CardProps) {
36
37
  const titleNoSpaces = title.replace(/\s+/g, '-').toLowerCase();
37
38
  const cardTitleId = `card-title-${titleNoSpaces}`;
38
- // Get align values
39
39
  const justifyContent =
40
40
  align === 'center' ? 'center' : align === 'end' ? 'flex-end' : 'flex-start';
41
41
  const alignItems = align === 'center' ? 'center' : align === 'end' ? 'flex-end' : 'flex-start';
42
42
  const textAlign = align === 'center' ? 'center' : align === 'end' ? 'right' : 'left';
43
- iconVariant = iconVariant ?? variant === 'ghost' ? 'filled' : 'ghost';
43
+ iconVariant = iconVariant ?? (variant === 'ghost' ? 'filled' : 'ghost');
44
44
 
45
45
  return (
46
46
  <CardWrapper
47
- as={to ? 'a' : 'div'}
48
- href={to}
47
+ as={to ? Link : 'div'}
48
+ to={to}
49
49
  aria-labelledby={cardTitleId}
50
50
  variant={variant}
51
51
  layout={layout}
@@ -61,11 +61,11 @@ export function Card({
61
61
  >
62
62
  {icon && <CardIcon variant={iconVariant} src={icon} rawContent={iconRawContent} />}
63
63
  <ContentWrapper>
64
- <Title id={cardTitleId} isCardLink={!!to} justifyContent={justifyContent}>
64
+ <Title id={cardTitleId} $isCardLink={!!to} $justifyContent={justifyContent}>
65
65
  {title}
66
66
  {!!to && <CardLinkIcon />}
67
67
  </Title>
68
- <Body lineClamp={lineClamp}>{children}</Body>
68
+ <Body $lineClamp={lineClamp}>{children}</Body>
69
69
  </ContentWrapper>
70
70
  </CardContentWrapper>
71
71
  </>
@@ -96,13 +96,13 @@ const ContentWrapper = styled.div`
96
96
  gap: var(--card-content-gap);
97
97
  `;
98
98
 
99
- const Title = styled.h3<{ isCardLink: boolean; justifyContent: string }>`
99
+ const Title = styled.h3<{ $isCardLink: boolean; $justifyContent: string }>`
100
100
  margin: var(--card-title-margin);
101
101
  font-weight: var(--card-title-font-weight);
102
102
  color: var(--card-title-text-color);
103
103
  display: flex;
104
104
  align-items: center;
105
- justify-content: ${({ justifyContent }) => justifyContent};
105
+ justify-content: ${({ $justifyContent }) => $justifyContent};
106
106
  width: 100%;
107
107
  `;
108
108
 
@@ -114,16 +114,16 @@ const CardLinkIcon = styled(ChevronRightIcon)`
114
114
  transition: opacity 0.3s, transform 0.3s;
115
115
  `;
116
116
 
117
- const Body = styled.div<{ lineClamp?: number }>`
117
+ const Body = styled.div<{ $lineClamp?: number }>`
118
118
  color: var(--card-text-color);
119
119
  font-size: var(--card-body-font-size);
120
120
  line-height: var(--card-body-line-height);
121
121
 
122
- ${({ lineClamp }) =>
123
- lineClamp &&
122
+ ${({ $lineClamp }) =>
123
+ $lineClamp &&
124
124
  `
125
125
  display: -webkit-box;
126
- -webkit-line-clamp: ${lineClamp};
126
+ -webkit-line-clamp: ${$lineClamp};
127
127
  -webkit-box-orient: vertical;
128
128
  overflow: hidden;
129
129
  text-overflow: ellipsis;`}
@@ -160,17 +160,17 @@ const Body = styled.div<{ lineClamp?: number }>`
160
160
  `;
161
161
 
162
162
  const CardWrapper = styled.div.attrs<{
163
- variant: string;
164
- isCardLink: boolean;
165
- }>(({ isCardLink, variant }) => ({
166
- className: getCardWrapperClass(isCardLink, variant),
163
+ $variant: string;
164
+ $isCardLink: boolean;
165
+ }>(({ $isCardLink, $variant }) => ({
166
+ className: getCardWrapperClass($isCardLink, $variant),
167
167
  }))<{
168
- variant: string;
169
- isCardLink: boolean;
170
- layout: string;
168
+ $variant: string;
169
+ $isCardLink: boolean;
170
+ $layout: string;
171
171
  }>`
172
172
  display: flex;
173
- flex-direction: ${({ layout }) => (layout === 'horizontal' ? 'row' : 'column')};
173
+ flex-direction: ${({ $layout }) => ($layout === 'horizontal' ? 'row' : 'column')};
174
174
  width: 100%;
175
175
  height: 100%;
176
176
  border-radius: var(--card-border-radius);
@@ -187,8 +187,8 @@ const CardWrapper = styled.div.attrs<{
187
187
  box-shadow: var(--card-box-shadow);
188
188
 
189
189
  && > img {
190
- ${({ layout }) =>
191
- layout === 'horizontal' &&
190
+ ${({ $layout }) =>
191
+ $layout === 'horizontal' &&
192
192
  `
193
193
  max-width: 33%;
194
194
  width: auto;
@@ -219,12 +219,12 @@ const CardWrapper = styled.div.attrs<{
219
219
  }
220
220
  `;
221
221
 
222
- const getCardWrapperClass = (isCardLink: boolean, variant?: string) => {
222
+ const getCardWrapperClass = ($isCardLink: boolean, $variant?: string) => {
223
223
  let classes = [];
224
224
 
225
- classes.push(`card-variant-${variant}`);
225
+ classes.push(`card-variant-${$variant}`);
226
226
 
227
- if (isCardLink) {
227
+ if ($isCardLink) {
228
228
  classes.push('card-link');
229
229
  }
230
230
 
@@ -11,7 +11,7 @@ export type CardIconProps = {
11
11
 
12
12
  export function CardIcon({ variant, src, rawContent }: CardIconProps) {
13
13
  return (
14
- <CardIconWrapper variant={variant}>
14
+ <CardIconWrapper $variant={variant}>
15
15
  {rawContent ? <CardSvg fileRawContent={rawContent} /> : <CardImg src={src} />}
16
16
  </CardIconWrapper>
17
17
  );
@@ -36,7 +36,7 @@ const CardSvg = styled(InlineSvg)`
36
36
  }
37
37
  `;
38
38
 
39
- const CardIconWrapper = styled.div<Omit<CardIconProps, 'src'>>`
39
+ const CardIconWrapper = styled.div<{ $variant?: string }>`
40
40
  display: flex;
41
41
  align-items: center;
42
42
  justify-content: center;
@@ -44,12 +44,12 @@ const CardIconWrapper = styled.div<Omit<CardIconProps, 'src'>>`
44
44
  min-height: var(--card-icon-height);
45
45
  flex-shrink: 0;
46
46
 
47
- padding: ${({ variant }) => (variant === 'ghost' ? '0' : `var(--card-icon-padding);`)};
47
+ padding: ${({ $variant }) => ($variant === 'ghost' ? '0' : `var(--card-icon-padding);`)};
48
48
  border-radius: var(--card-icon-border-radius);
49
49
  overflow: hidden;
50
50
 
51
- background-color: ${({ variant }) =>
52
- variant === 'ghost' ? 'transparent' : 'var(--card-icon-bg-color)'};
53
- border: ${({ variant }) =>
54
- variant === 'ghost' ? 'none' : `1px solid var(--card-icon-border-color)`};
51
+ background-color: ${({ $variant }) =>
52
+ $variant === 'ghost' ? 'transparent' : 'var(--card-icon-bg-color)'};
53
+ border: ${({ $variant }) =>
54
+ $variant === 'ghost' ? 'none' : `1px solid var(--card-icon-border-color)`};
55
55
  `;
@@ -8,14 +8,14 @@ export type CardImageProps = {
8
8
  };
9
9
 
10
10
  export function CardImage({ src, alt, position }: CardImageProps) {
11
- return <Image src={src} alt={alt} position={position} />;
11
+ return <Image src={src} alt={alt} $position={position} />;
12
12
  }
13
13
 
14
- const Image = styled.img<{ position?: string }>`
14
+ const Image = styled.img<{ $position?: string }>`
15
15
  width: 100%;
16
16
  height: 100px;
17
17
  flex-shrink: 0;
18
18
  object-fit: cover;
19
19
 
20
- order: ${({ position }) => (position === 'end' ? 1 : 0)};
20
+ order: ${({ $position }) => ($position === 'end' ? 1 : 0)};
21
21
  `;
@@ -11,8 +11,8 @@ export type CardsProps = React.PropsWithChildren<{
11
11
  export function Cards({ cardMinWidth = 240, columns, className, children, ariaLabel }: CardsProps) {
12
12
  return (
13
13
  <GridLayout
14
- cardMinWidth={cardMinWidth}
15
- columns={columns}
14
+ $cardMinWidth={cardMinWidth}
15
+ $columns={columns}
16
16
  className={className}
17
17
  aria-label={ariaLabel}
18
18
  >
@@ -22,14 +22,22 @@ export function Cards({ cardMinWidth = 240, columns, className, children, ariaLa
22
22
  }
23
23
 
24
24
  const GridLayout = styled.div<{
25
- cardMinWidth: number;
26
- columns?: number;
25
+ $cardMinWidth: number;
26
+ $columns?: number;
27
27
  }>`
28
28
  display: grid;
29
- grid-template-columns: ${({ cardMinWidth, columns }) =>
30
- `repeat(${columns || 'auto-fit'}, minmax(${cardMinWidth}px, 1fr))`};
29
+ grid-template-columns: ${({ $cardMinWidth, $columns }) =>
30
+ `repeat(auto-fit, minmax(${getCardMinWidth($cardMinWidth, $columns)}, 1fr))`};
31
31
  gap: var(--cards-gap);
32
32
  width: 100%;
33
33
  margin-top: var(--spacing-base);
34
34
  margin-bottom: var(--spacing-base);
35
35
  `;
36
+
37
+ function getColumnWidth(columns: number) {
38
+ return `calc((100% - ${columns - 1} * var(--cards-gap)) / ${columns})`;
39
+ }
40
+
41
+ function getCardMinWidth(cardMinWidth: number, columns?: number) {
42
+ return columns ? `max(${getColumnWidth(columns)}, ${cardMinWidth}px)` : `${cardMinWidth}px`;
43
+ }
@@ -47,7 +47,7 @@ export const card: MarkdocSchemaWrapper = {
47
47
  type: String,
48
48
  matches: ['filled', 'ghost'],
49
49
  },
50
- to: { type: String },
50
+ to: { type: String, resolver: 'link' },
51
51
  },
52
52
  children: ['paragraph', 'tag', 'list'],
53
53
  },