@bitrise/bitkit-v2 0.3.227 → 0.3.228
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/AGENTS.md +1 -0
- package/dist/components/BitkitDefinitionTooltip/BitkitDefinitionTooltip.d.ts +2 -1
- package/dist/components/BitkitDefinitionTooltip/BitkitDefinitionTooltip.js +2 -1
- package/dist/components/BitkitDefinitionTooltip/BitkitDefinitionTooltip.js.map +1 -1
- package/dist/theme/recipes/DefinitionTooltip.recipe.js +1 -0
- package/dist/theme/recipes/DefinitionTooltip.recipe.js.map +1 -1
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -124,6 +124,7 @@ Bitkit components use consistent prop names across the library:
|
|
|
124
124
|
- **Omit default prop values** — `<IconCross />`, not `<IconCross size="24" />` when 24 is the default.
|
|
125
125
|
- **No shorthand props** — use full names: `marginInline`, `paddingBlockEnd`, `width`, `background`, `padding`. Never `mx`, `pb`, `w`, `bg`, `p`, `mt`.
|
|
126
126
|
- **Prefer logical over physical properties** — `marginInline`, `paddingBlock`, `insetInlineStart` over `marginLeft`/`marginRight`, `paddingTop`/`paddingBottom`, `left`.
|
|
127
|
+
- **Prefer Chakra's `truncate` over manual CSS** — `truncate={true}` is a boolean style prop available on every `chakra.*` element / Chakra component (and every Bitkit component that forwards style props). Use it instead of `overflow: 'hidden'` + `textOverflow: 'ellipsis'` + `whiteSpace: 'nowrap'`.
|
|
127
128
|
- **Never wrap a Bitkit component in `<Box>` for styling** — most Bitkit components accept Chakra style props (`width`, `flex`, `flexShrink`, `marginInline`, `padding`, `display`, etc.) directly on themselves. Set them on the component, never on a wrapper:
|
|
128
129
|
```tsx
|
|
129
130
|
// Bad — pointless wrapper
|
|
@@ -9,9 +9,10 @@ export interface BitkitDefinitionTooltipProps {
|
|
|
9
9
|
placement?: NonNullable<TooltipRootProps['positioning']>['placement'];
|
|
10
10
|
text: string;
|
|
11
11
|
textSize?: 'lg' | 'md' | 'sm';
|
|
12
|
+
truncate?: boolean;
|
|
12
13
|
}
|
|
13
14
|
declare const BitkitDefinitionTooltip: {
|
|
14
|
-
({ button, children, learnMoreTarget, learnMoreUrl, method, placement, text, textSize, }: BitkitDefinitionTooltipProps): import("react/jsx-runtime").JSX.Element;
|
|
15
|
+
({ button, children, learnMoreTarget, learnMoreUrl, method, placement, text, textSize, truncate, }: BitkitDefinitionTooltipProps): import("react/jsx-runtime").JSX.Element;
|
|
15
16
|
displayName: string;
|
|
16
17
|
};
|
|
17
18
|
export default BitkitDefinitionTooltip;
|
|
@@ -3,7 +3,7 @@ import { chakra, useRecipe } from "@chakra-ui/react/styled-system";
|
|
|
3
3
|
import { useState } from "react";
|
|
4
4
|
import { jsx } from "react/jsx-runtime";
|
|
5
5
|
//#region lib/components/BitkitDefinitionTooltip/BitkitDefinitionTooltip.tsx
|
|
6
|
-
var BitkitDefinitionTooltip = ({ button, children, learnMoreTarget, learnMoreUrl, method = "click", placement = "top", text, textSize }) => {
|
|
6
|
+
var BitkitDefinitionTooltip = ({ button, children, learnMoreTarget, learnMoreUrl, method = "click", placement = "top", text, textSize, truncate = true }) => {
|
|
7
7
|
const style = useRecipe({ key: "definitionTooltip" });
|
|
8
8
|
const [open, setOpen] = useState(false);
|
|
9
9
|
return /* @__PURE__ */ jsx(BitkitTooltip, {
|
|
@@ -25,6 +25,7 @@ var BitkitDefinitionTooltip = ({ button, children, learnMoreTarget, learnMoreUrl
|
|
|
25
25
|
textSize
|
|
26
26
|
}),
|
|
27
27
|
onClick: method === "click" ? () => setOpen(!open) : void 0,
|
|
28
|
+
truncate,
|
|
28
29
|
type: "button",
|
|
29
30
|
children
|
|
30
31
|
})
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BitkitDefinitionTooltip.js","names":[],"sources":["../../../lib/components/BitkitDefinitionTooltip/BitkitDefinitionTooltip.tsx"],"sourcesContent":["import { chakra, useRecipe } from '@chakra-ui/react/styled-system';\nimport { type TooltipRootProps } from '@chakra-ui/react/tooltip';\nimport { useState } from 'react';\n\nimport BitkitTooltip, { type BitkitTooltipProps } from '../BitkitTooltip/BitkitTooltip';\n\nexport interface BitkitDefinitionTooltipProps {\n button?: BitkitTooltipProps['button'];\n children: string;\n learnMoreTarget?: BitkitTooltipProps['learnMoreTarget'];\n learnMoreUrl?: BitkitTooltipProps['learnMoreUrl'];\n method?: 'click' | 'hover';\n placement?: NonNullable<TooltipRootProps['positioning']>['placement'];\n text: string;\n textSize?: 'lg' | 'md' | 'sm';\n}\n\nconst BitkitDefinitionTooltip = ({\n button,\n children,\n learnMoreTarget,\n learnMoreUrl,\n method = 'click',\n placement = 'top',\n text,\n textSize,\n}: BitkitDefinitionTooltipProps) => {\n const style = useRecipe({ key: 'definitionTooltip' });\n const [open, setOpen] = useState(false);\n\n return (\n <BitkitTooltip\n button={button}\n closeOnClick={method === 'click' ? false : undefined}\n learnMoreTarget={learnMoreTarget}\n learnMoreUrl={learnMoreUrl}\n onOpenChange={\n method === 'click'\n ? ({ open: nextOpen }) => {\n if (!nextOpen) setOpen(false);\n }\n : undefined\n }\n open={method === 'click' ? open : undefined}\n openDelay={method === 'click' ? Infinity : undefined}\n placement={placement}\n text={text}\n >\n <chakra.button\n aria-expanded={method === 'click' ? open : undefined}\n css={style({ method, textSize })}\n onClick={method === 'click' ? () => setOpen(!open) : undefined}\n type=\"button\"\n >\n {children}\n </chakra.button>\n </BitkitTooltip>\n );\n};\n\nBitkitDefinitionTooltip.displayName = 'BitkitDefinitionTooltip';\n\nexport default BitkitDefinitionTooltip;\n"],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"BitkitDefinitionTooltip.js","names":[],"sources":["../../../lib/components/BitkitDefinitionTooltip/BitkitDefinitionTooltip.tsx"],"sourcesContent":["import { chakra, useRecipe } from '@chakra-ui/react/styled-system';\nimport { type TooltipRootProps } from '@chakra-ui/react/tooltip';\nimport { useState } from 'react';\n\nimport BitkitTooltip, { type BitkitTooltipProps } from '../BitkitTooltip/BitkitTooltip';\n\nexport interface BitkitDefinitionTooltipProps {\n button?: BitkitTooltipProps['button'];\n children: string;\n learnMoreTarget?: BitkitTooltipProps['learnMoreTarget'];\n learnMoreUrl?: BitkitTooltipProps['learnMoreUrl'];\n method?: 'click' | 'hover';\n placement?: NonNullable<TooltipRootProps['positioning']>['placement'];\n text: string;\n textSize?: 'lg' | 'md' | 'sm';\n truncate?: boolean;\n}\n\nconst BitkitDefinitionTooltip = ({\n button,\n children,\n learnMoreTarget,\n learnMoreUrl,\n method = 'click',\n placement = 'top',\n text,\n textSize,\n truncate = true,\n}: BitkitDefinitionTooltipProps) => {\n const style = useRecipe({ key: 'definitionTooltip' });\n const [open, setOpen] = useState(false);\n\n return (\n <BitkitTooltip\n button={button}\n closeOnClick={method === 'click' ? false : undefined}\n learnMoreTarget={learnMoreTarget}\n learnMoreUrl={learnMoreUrl}\n onOpenChange={\n method === 'click'\n ? ({ open: nextOpen }) => {\n if (!nextOpen) setOpen(false);\n }\n : undefined\n }\n open={method === 'click' ? open : undefined}\n openDelay={method === 'click' ? Infinity : undefined}\n placement={placement}\n text={text}\n >\n <chakra.button\n aria-expanded={method === 'click' ? open : undefined}\n css={style({ method, textSize })}\n onClick={method === 'click' ? () => setOpen(!open) : undefined}\n truncate={truncate}\n type=\"button\"\n >\n {children}\n </chakra.button>\n </BitkitTooltip>\n );\n};\n\nBitkitDefinitionTooltip.displayName = 'BitkitDefinitionTooltip';\n\nexport default BitkitDefinitionTooltip;\n"],"mappings":";;;;;AAkBA,IAAM,2BAA2B,EAC/B,QACA,UACA,iBACA,cACA,SAAS,SACT,YAAY,OACZ,MACA,UACA,WAAW,WACuB;CAClC,MAAM,QAAQ,UAAU,EAAE,KAAK,oBAAoB,CAAC;CACpD,MAAM,CAAC,MAAM,WAAW,SAAS,KAAK;CAEtC,OACE,oBAAC,eAAD;EACU;EACR,cAAc,WAAW,UAAU,QAAQ,KAAA;EAC1B;EACH;EACd,cACE,WAAW,WACN,EAAE,MAAM,eAAe;GACtB,IAAI,CAAC,UAAU,QAAQ,KAAK;EAC9B,IACA,KAAA;EAEN,MAAM,WAAW,UAAU,OAAO,KAAA;EAClC,WAAW,WAAW,UAAU,WAAW,KAAA;EAChC;EACL;YAEN,oBAAC,OAAO,QAAR;GACE,iBAAe,WAAW,UAAU,OAAO,KAAA;GAC3C,KAAK,MAAM;IAAE;IAAQ;GAAS,CAAC;GAC/B,SAAS,WAAW,gBAAgB,QAAQ,CAAC,IAAI,IAAI,KAAA;GAC3C;GACV,MAAK;GAEJ;EACY,CAAA;CACF,CAAA;AAEnB;AAEA,wBAAwB,cAAc"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DefinitionTooltip.recipe.js","names":[],"sources":["../../../lib/theme/recipes/DefinitionTooltip.recipe.ts"],"sourcesContent":["import { defineRecipe } from '@chakra-ui/react/styled-system';\n\nconst definitionTooltipRecipe = defineRecipe({\n className: 'definition-tooltip',\n base: {\n color: 'inherit',\n font: 'inherit',\n letterSpacing: 'inherit',\n textDecoration: 'underline dotted',\n textDecorationColor: 'sys/neutral/bold',\n textUnderlineOffset: '0.375em',\n '&:hover': {\n textDecorationColor: 'sys/purple/base',\n },\n },\n variants: {\n method: {\n click: {\n cursor: 'pointer',\n },\n hover: {\n cursor: 'default',\n },\n },\n textSize: {\n lg: { textStyle: 'body/lg/regular' },\n md: { textStyle: 'body/md/regular' },\n sm: { textStyle: 'body/sm/regular' },\n },\n },\n defaultVariants: {\n textSize: 'lg',\n },\n});\n\nexport default definitionTooltipRecipe;\n"],"mappings":";;AAEA,IAAM,0BAA0B,aAAa;CAC3C,WAAW;CACX,MAAM;EACJ,OAAO;EACP,MAAM;EACN,eAAe;EACf,gBAAgB;EAChB,qBAAqB;EACrB,qBAAqB;EACrB,WAAW,EACT,qBAAqB,kBACvB;CACF;CACA,UAAU;EACR,QAAQ;GACN,OAAO,EACL,QAAQ,UACV;GACA,OAAO,EACL,QAAQ,UACV;EACF;EACA,UAAU;GACR,IAAI,EAAE,WAAW,kBAAkB;GACnC,IAAI,EAAE,WAAW,kBAAkB;GACnC,IAAI,EAAE,WAAW,kBAAkB;EACrC;CACF;CACA,iBAAiB,EACf,UAAU,KACZ;AACF,CAAC"}
|
|
1
|
+
{"version":3,"file":"DefinitionTooltip.recipe.js","names":[],"sources":["../../../lib/theme/recipes/DefinitionTooltip.recipe.ts"],"sourcesContent":["import { defineRecipe } from '@chakra-ui/react/styled-system';\n\nconst definitionTooltipRecipe = defineRecipe({\n className: 'definition-tooltip',\n base: {\n color: 'inherit',\n font: 'inherit',\n letterSpacing: 'inherit',\n maxWidth: '100%',\n textDecoration: 'underline dotted',\n textDecorationColor: 'sys/neutral/bold',\n textUnderlineOffset: '0.375em',\n '&:hover': {\n textDecorationColor: 'sys/purple/base',\n },\n },\n variants: {\n method: {\n click: {\n cursor: 'pointer',\n },\n hover: {\n cursor: 'default',\n },\n },\n textSize: {\n lg: { textStyle: 'body/lg/regular' },\n md: { textStyle: 'body/md/regular' },\n sm: { textStyle: 'body/sm/regular' },\n },\n },\n defaultVariants: {\n textSize: 'lg',\n },\n});\n\nexport default definitionTooltipRecipe;\n"],"mappings":";;AAEA,IAAM,0BAA0B,aAAa;CAC3C,WAAW;CACX,MAAM;EACJ,OAAO;EACP,MAAM;EACN,eAAe;EACf,UAAU;EACV,gBAAgB;EAChB,qBAAqB;EACrB,qBAAqB;EACrB,WAAW,EACT,qBAAqB,kBACvB;CACF;CACA,UAAU;EACR,QAAQ;GACN,OAAO,EACL,QAAQ,UACV;GACA,OAAO,EACL,QAAQ,UACV;EACF;EACA,UAAU;GACR,IAAI,EAAE,WAAW,kBAAkB;GACnC,IAAI,EAAE,WAAW,kBAAkB;GACnC,IAAI,EAAE,WAAW,kBAAkB;EACrC;CACF;CACA,iBAAiB,EACf,UAAU,KACZ;AACF,CAAC"}
|