@brilo/base-blocks 0.1.26 → 0.1.27

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 (43) hide show
  1. package/README.md +34 -11
  2. package/build/.tsbuildinfo +1 -1
  3. package/build/blocks/accordion/accordion-group/constants.d.ts +2 -0
  4. package/build/blocks/accordion/accordion-group/constants.d.ts.map +1 -0
  5. package/build/blocks/accordion/accordion-group/constants.js +1 -0
  6. package/build/blocks/accordion/accordion-group/edit.d.ts +6 -0
  7. package/build/blocks/accordion/accordion-group/edit.d.ts.map +1 -0
  8. package/build/blocks/accordion/accordion-group/edit.js +21 -0
  9. package/build/blocks/accordion/accordion-group/factory.d.ts +5 -0
  10. package/build/blocks/accordion/accordion-group/factory.d.ts.map +1 -0
  11. package/build/blocks/accordion/accordion-group/factory.js +26 -0
  12. package/build/blocks/accordion/accordion-group/index.d.ts +5 -0
  13. package/build/blocks/accordion/accordion-group/index.d.ts.map +1 -0
  14. package/build/blocks/accordion/accordion-group/index.js +7 -0
  15. package/build/blocks/accordion/accordion-group/types.d.ts +9 -0
  16. package/build/blocks/accordion/accordion-group/types.d.ts.map +1 -0
  17. package/build/blocks/accordion/accordion-group/types.js +1 -0
  18. package/build/blocks/accordion/accordion-item/edit.d.ts +6 -0
  19. package/build/blocks/accordion/accordion-item/edit.d.ts.map +1 -0
  20. package/build/blocks/accordion/accordion-item/edit.js +14 -0
  21. package/build/blocks/accordion/accordion-item/factory.d.ts +5 -0
  22. package/build/blocks/accordion/accordion-item/factory.d.ts.map +1 -0
  23. package/build/blocks/accordion/accordion-item/factory.js +21 -0
  24. package/build/blocks/accordion/accordion-item/index.d.ts +5 -0
  25. package/build/blocks/accordion/accordion-item/index.d.ts.map +1 -0
  26. package/build/blocks/accordion/accordion-item/index.js +5 -0
  27. package/build/blocks/accordion/accordion-item/types.d.ts +7 -0
  28. package/build/blocks/accordion/accordion-item/types.d.ts.map +1 -0
  29. package/build/blocks/accordion/accordion-item/types.js +1 -0
  30. package/build/index.d.ts +4 -0
  31. package/build/index.d.ts.map +1 -1
  32. package/build/index.js +2 -0
  33. package/package.json +1 -1
  34. package/src/blocks/accordion/accordion-group/constants.ts +1 -0
  35. package/src/blocks/accordion/accordion-group/edit.tsx +45 -0
  36. package/src/blocks/accordion/accordion-group/factory.tsx +29 -0
  37. package/src/blocks/accordion/accordion-group/index.ts +11 -0
  38. package/src/blocks/accordion/accordion-group/types.ts +10 -0
  39. package/src/blocks/accordion/accordion-item/edit.tsx +47 -0
  40. package/src/blocks/accordion/accordion-item/factory.tsx +24 -0
  41. package/src/blocks/accordion/accordion-item/index.ts +9 -0
  42. package/src/blocks/accordion/accordion-item/types.ts +7 -0
  43. package/src/index.ts +4 -0
package/README.md CHANGED
@@ -4,31 +4,54 @@ Shared Gutenberg block factory library. Tenants consume it as a local file depen
4
4
 
5
5
  ## Install (tenant)
6
6
 
7
- In tenant `package.json`:
8
- ```json
9
- "@brilo/base-blocks": "file:../../../../assets/lib/brilo/base-blocks"
7
+ Published as `@brilo/base-blocks` npm package — normal `bun install` in tenant pulls it.
8
+
9
+ For local dev against uncommitted base-blocks changes, use `bun link`:
10
+
11
+ ```bash
12
+ # in base-blocks
13
+ bun run build
14
+ bun link
15
+
16
+ # in tenant gutenberg dir
17
+ bun link @brilo/base-blocks
10
18
  ```
11
19
 
12
- Then run `bun install`. Re-run after adding new files to base-blocks (bun links only files known at install time).
20
+ Re-run `bun run build` in base-blocks after any change — link points at `build/`, not `src/`.
13
21
 
14
22
  ## Structure
15
23
 
16
24
  ```
17
25
  src/
18
26
  blocks/
19
- sections/ base-section
20
- groups/ basic-header-group · button-group · usp-group · text-and-media-group
21
- core/ basic-button · basic-heading · basic-overline
22
- items/ usp-item
23
- components/ IconControl · ImagePicker
24
- hooks/ useGroupBlock
27
+ <domain>/ domain folders, one per content type — mirrors frontoffice
28
+ twig components 1:1: anchor/, compare/, contact/, faq/,
29
+ gallery/, hero/, person/, signpost/, step/, testimonial/,
30
+ usp/ … each with <domain>-group/ and/or <domain>-item/
31
+ core/ atomic, no inner blocks: basic-button · basic-heading · basic-overline
32
+ groups/ generic (non-domain) layout groups: banner-group · basic-header-group ·
33
+ button-group · content-group · text-and-media-group
34
+ sections/ top-level page sections: base-section
35
+ layout/ aside/content layout blocks
36
+ form/ form-group · form-field
37
+ link/ · map/ · newsletter/ · post/ · responsive-grid/
38
+ components/ IconControl · ImagePicker · ItemIconControl
39
+ hooks/ useGroupBlock · useTenantColorPalette
25
40
  utils/ createEditAdapter
26
41
  editor.scss SCSS barrel — @forward all block + component + global styles
27
42
  globals.scss global editor utility classes (flex, gap-*, u-grid-*, …)
28
43
  index.ts JS/TS barrel
29
- types.ts shared types (BaseBlockAttributes, BaseSectionOptions, …)
44
+ types.ts shared types (BriloBlockType, SelectOption, Icon, OptionArray, …)
30
45
  ```
31
46
 
47
+ Each block folder: `factory.tsx`, `edit.tsx`, `types.ts`, `constants.ts` (if
48
+ any option arrays), `icon.tsx` (if custom icon), `index.ts`, `editor.scss`.
49
+ Imports reach shared code via the `~/*` alias (`~/types`, `~/hooks/...`,
50
+ `~/components/...`), never relative climbing. See
51
+ [BLOCKS_GUIDE.md](./BLOCKS_GUIDE.md) for the full authoring guide — treat it
52
+ (and actual `src/blocks/*`) as source of truth over `docs/*.md`, which
53
+ describe an older layout.
54
+
32
55
  ## Styles (tenant)
33
56
 
34
57
  In tenant `index.scss`: