@synerise/ds-block 1.0.56 → 1.0.58
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/CHANGELOG.md +8 -0
- package/CLAUDE.md +59 -0
- package/package.json +5 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.0.58](https://github.com/Synerise/synerise-design/compare/@synerise/ds-block@1.0.57...@synerise/ds-block@1.0.58) (2026-08-11)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @synerise/ds-block
|
|
9
|
+
|
|
10
|
+
## [1.0.57](https://github.com/Synerise/synerise-design/compare/@synerise/ds-block@1.0.56...@synerise/ds-block@1.0.57) (2026-07-23)
|
|
11
|
+
|
|
12
|
+
**Note:** Version bump only for package @synerise/ds-block
|
|
13
|
+
|
|
6
14
|
## [1.0.56](https://github.com/Synerise/synerise-design/compare/@synerise/ds-block@1.0.55...@synerise/ds-block@1.0.56) (2026-06-17)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @synerise/ds-block
|
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Block (`@synerise/ds-block`)
|
|
2
|
+
|
|
3
|
+
> **DEPRECATED.** Will receive no further updates and will be removed from a future DS version. Do not use in new code.
|
|
4
|
+
|
|
5
|
+
A minimal drag-placeholder item: renders an icon + label inside a grey card that switches to a dashed empty outline while being dragged. No known replacement — check with the DS team before any new usage.
|
|
6
|
+
|
|
7
|
+
## Package structure
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
src/
|
|
11
|
+
Block.tsx — @deprecated main component
|
|
12
|
+
Block.types.ts — BlockProps
|
|
13
|
+
Block.styles.ts — BlockWrapper, BlockContent, BlockName styled components
|
|
14
|
+
index.ts — default export only
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Public exports
|
|
18
|
+
|
|
19
|
+
### `Block` (default)
|
|
20
|
+
|
|
21
|
+
`@deprecated` — frozen, no further development planned.
|
|
22
|
+
|
|
23
|
+
| Prop | Type | Default | Description |
|
|
24
|
+
|------|------|---------|-------------|
|
|
25
|
+
| `children` | `ReactNode \| string` | _(required)_ | Label text displayed next to the icon. |
|
|
26
|
+
| `isDragging` | `boolean` | _(required)_ | When `true`, adds the `is-dragging` CSS class — hides icon and label, shows a dashed border outline. |
|
|
27
|
+
| `icon` | `ReactNode` | _(required)_ | Icon element rendered to the left of the label. |
|
|
28
|
+
| `className` | `string` | `undefined` | Extra class on the outer wrapper (always includes `ds-block`). |
|
|
29
|
+
|
|
30
|
+
`BlockProps` is **not** exported from `index.ts` — import directly from the source if needed:
|
|
31
|
+
```ts
|
|
32
|
+
import type { BlockProps } from '@synerise/ds-block/dist/Block.types';
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Usage patterns
|
|
36
|
+
|
|
37
|
+
```tsx
|
|
38
|
+
// ⚠️ DEPRECATED — avoid in new code
|
|
39
|
+
import Block from '@synerise/ds-block';
|
|
40
|
+
|
|
41
|
+
<Block isDragging={false} icon={<Icon component={<SomeIcon />} />}>
|
|
42
|
+
Block label
|
|
43
|
+
</Block>
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Styling
|
|
47
|
+
|
|
48
|
+
`Block.styles.ts` uses `@synerise/ds-typography` `macro.h200` and `@synerise/ds-core` theme palette tokens:
|
|
49
|
+
- Default: grey-050 background, transparent border, grey-600 text.
|
|
50
|
+
- Hover: grey-800 text and icon colour.
|
|
51
|
+
- `is-dragging`: dashed grey-400 border, icon and label hidden (`display: none`).
|
|
52
|
+
- `BlockWrapper` uses `flex: 0 0 50%` — designed to sit in a two-column flex grid.
|
|
53
|
+
|
|
54
|
+
## Implementation notes
|
|
55
|
+
|
|
56
|
+
- **`isDragging` is required** — there is no default value in `BlockProps`. Omitting it causes a TypeScript error.
|
|
57
|
+
- **`icon` is required** — same, no default value.
|
|
58
|
+
- **`BlockProps` not re-exported** — `index.ts` only has `export { default }`. The types are only accessible via a direct dist path import.
|
|
59
|
+
- The component creates an internal `useRef<HTMLDivElement>` but never uses it for anything — it is not forwarded and no imperative handle is exposed.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@synerise/ds-block",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.58",
|
|
4
4
|
"description": "Block UI Component for the Synerise Design System",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"repository": "Synerise/synerise-design",
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
"files": [
|
|
18
18
|
"/dist",
|
|
19
19
|
"CHANGELOG.md",
|
|
20
|
+
"CLAUDE.md",
|
|
20
21
|
"README.md",
|
|
21
22
|
"package.json",
|
|
22
23
|
"LICENSE.md"
|
|
@@ -41,8 +42,8 @@
|
|
|
41
42
|
],
|
|
42
43
|
"types": "dist/index.d.ts",
|
|
43
44
|
"dependencies": {
|
|
44
|
-
"@synerise/ds-icon": "^1.18.
|
|
45
|
-
"@synerise/ds-typography": "^1.1.
|
|
45
|
+
"@synerise/ds-icon": "^1.18.5",
|
|
46
|
+
"@synerise/ds-typography": "^1.1.28"
|
|
46
47
|
},
|
|
47
48
|
"peerDependencies": {
|
|
48
49
|
"@synerise/ds-core": "*",
|
|
@@ -51,5 +52,5 @@
|
|
|
51
52
|
"styled-components": "^5.3.3",
|
|
52
53
|
"vitest": "4"
|
|
53
54
|
},
|
|
54
|
-
"gitHead": "
|
|
55
|
+
"gitHead": "6df24ed12cd5f276d8eccde730591807982e3385"
|
|
55
56
|
}
|