@nocode-factory/sanity-kit 2.66.0 → 2.67.0-rc.1

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.
@@ -1,11 +1,12 @@
1
- import {useEffect, useRef, useState} from 'react'
1
+ import {useEffect} from 'react'
2
2
  import type {OverlayComponentResolver} from '@sanity/visual-editing'
3
3
  import {EditAudit} from './EditAudit'
4
4
  import {ImageReplaceLayer} from './ImageReplaceLayer'
5
5
  import {InlineTextEditor} from './InlineTextEditor'
6
6
  import {InlineTextOverlay} from './InlineTextOverlay'
7
- import {CHIP, FONT, DEFAULT_PREVIEW_EDITING_LABELS, type PreviewEditingLabels} from './labels'
8
- import {EDIT_MODE_ATTRIBUTE, EDIT_MODE_STORAGE_KEY, PREVIEW_EDIT_ATTRIBUTE, isEditMode, isInlineEditablePath, setEditModeResolver} from './store'
7
+ import {DEFAULT_PREVIEW_EDITING_LABELS, type PreviewEditingLabels} from './labels'
8
+ import {useNativeEditMode} from './nativeEditMode'
9
+ import {PREVIEW_EDIT_ATTRIBUTE, isEditMode, isInlineEditablePath} from './store'
9
10
 
10
11
  /**
11
12
  * ÉDITION SUR PLACE dans l'aperçu (Presentation), à monter à côté de
@@ -20,7 +21,8 @@ import {EDIT_MODE_ATTRIBUTE, EDIT_MODE_STORAGE_KEY, PREVIEW_EDIT_ATTRIBUTE, isEd
20
21
  * clic un champ de saisie à sa place exacte ; enregistré dans le brouillon ;
21
22
  * - image : « Replace this image » au survol, au clic le Studio ouvre la
22
23
  * médiathèque (pont monté par le plugin du kit) ;
23
- * - « Mode édition / Mode visite » : en visite, un clic suit les liens.
24
+ * - interrupteur natif « Edit » de Presentation (à côté de l'adresse) : éteint, la page
25
+ * se comporte comme le site (un clic suit les liens). Le kit n'a pas d'interrupteur.
24
26
  */
25
27
  export const ncfOverlayComponents: OverlayComponentResolver = (context) => {
26
28
  if (isEditMode() && isInlineEditablePath(context.type, context.node.path, context.element)) return InlineTextOverlay
@@ -30,12 +32,6 @@ export const ncfOverlayComponents: OverlayComponentResolver = (context) => {
30
32
  export type NcfPreviewEditingProps = {
31
33
  /** Libellés (anglais par défaut) : passer ceux de la langue du projet. */
32
34
  labels?: Partial<PreviewEditingLabels>
33
- /**
34
- * `'toggle'` (défaut) : interrupteur « Edit mode / Browse mode » du kit, en bas
35
- * à droite de l'aperçu, mémorisé. Une fonction : le projet décide (ex. son propre
36
- * interrupteur d'animations) ; le kit n'affiche alors rien.
37
- */
38
- editMode?: 'toggle' | (() => boolean)
39
35
  }
40
36
 
41
37
  /**
@@ -45,17 +41,12 @@ export type NcfPreviewEditingProps = {
45
41
  */
46
42
  const EDIT_CSS = `html[${PREVIEW_EDIT_ATTRIBUTE}] a::after, html[${PREVIEW_EDIT_ATTRIBUTE}] a::before { pointer-events: none !important; }`
47
43
 
48
- export function NcfPreviewEditing({labels, editMode = 'toggle'}: NcfPreviewEditingProps) {
44
+ export function NcfPreviewEditing({labels}: NcfPreviewEditingProps) {
49
45
  const text = {...DEFAULT_PREVIEW_EDITING_LABELS, ...labels}
50
- const custom = typeof editMode === 'function' ? editMode : null
51
- // Dernière fonction du projet, sans relancer l'effet à chaque rendu.
52
- const customRef = useRef(custom)
53
- customRef.current = custom
54
- const hasCustom = custom !== null
55
46
  useOverlayRectRefresh()
47
+ useNativeEditMode()
56
48
 
57
49
  useEffect(() => {
58
- setEditModeResolver(hasCustom ? () => customRef.current?.() ?? false : null)
59
50
  const root = document.documentElement
60
51
  // Ne touche l'attribut que s'il doit changer : l'observateur ci-dessous ne se
61
52
  // relance pas lui-même.
@@ -65,16 +56,15 @@ export function NcfPreviewEditing({labels, editMode = 'toggle'}: NcfPreviewEditi
65
56
  else if (!want && root.hasAttribute(PREVIEW_EDIT_ATTRIBUTE)) root.removeAttribute(PREVIEW_EDIT_ATTRIBUTE)
66
57
  }
67
58
  sync()
68
- // Le mode peut changer sans rechargement (interrupteur du kit ou du projet,
69
- // qui posent un attribut sur <html>) : on resynchronise à chaque changement.
59
+ // « Edit » change sans rechargement (useNativeEditMode pose data-ncf-edit-mode sur
60
+ // <html>) : on resynchronise à chaque changement.
70
61
  const observer = new MutationObserver(sync)
71
62
  observer.observe(root, {attributes: true})
72
63
  return () => {
73
64
  observer.disconnect()
74
65
  root.removeAttribute(PREVIEW_EDIT_ATTRIBUTE)
75
- setEditModeResolver(null)
76
66
  }
77
- }, [hasCustom])
67
+ }, [])
78
68
 
79
69
  return (
80
70
  <>
@@ -82,80 +72,10 @@ export function NcfPreviewEditing({labels, editMode = 'toggle'}: NcfPreviewEditi
82
72
  <InlineTextEditor labels={text} />
83
73
  <ImageReplaceLayer label={text.replaceImage} />
84
74
  <EditAudit labels={text} />
85
- {!hasCustom && <EditModeToggle labels={text} />}
86
75
  </>
87
76
  )
88
77
  }
89
78
 
90
- /** Interrupteur « Edit mode / Browse mode » : affiché dans l'aperçu du Studio seulement. */
91
- function EditModeToggle({labels}: {labels: PreviewEditingLabels}) {
92
- const [embedded, setEmbedded] = useState(false)
93
- const [edit, setEdit] = useState(true)
94
-
95
- useEffect(() => {
96
- let inFrame = true
97
- try {
98
- inFrame = window.self !== window.top
99
- } catch {
100
- inFrame = true
101
- }
102
- setEmbedded(inFrame)
103
- let stored: string | null = null
104
- try {
105
- stored = window.localStorage.getItem(EDIT_MODE_STORAGE_KEY)
106
- } catch {
107
- stored = null
108
- }
109
- const next = stored !== 'browse'
110
- setEdit(next)
111
- document.documentElement.setAttribute(EDIT_MODE_ATTRIBUTE, next ? 'edit' : 'browse')
112
- return () => document.documentElement.removeAttribute(EDIT_MODE_ATTRIBUTE)
113
- }, [])
114
-
115
- if (!embedded) return null
116
- const toggle = () => {
117
- const next = !edit
118
- setEdit(next)
119
- document.documentElement.setAttribute(EDIT_MODE_ATTRIBUTE, next ? 'edit' : 'browse')
120
- try {
121
- window.localStorage.setItem(EDIT_MODE_STORAGE_KEY, next ? 'edit' : 'browse')
122
- } catch {
123
- // Stockage indisponible : le choix vaut pour cette page seulement.
124
- }
125
- }
126
-
127
- return (
128
- <button
129
- type="button"
130
- role="switch"
131
- aria-checked={edit}
132
- aria-label={labels.modeLabel}
133
- onClick={toggle}
134
- data-sanity-overlay-element
135
- style={{
136
- position: 'fixed',
137
- right: 16,
138
- bottom: 16,
139
- zIndex: 2147482500,
140
- display: 'flex',
141
- alignItems: 'center',
142
- gap: 8,
143
- padding: '8px 14px 8px 10px',
144
- border: 0,
145
- borderRadius: 999,
146
- background: CHIP,
147
- color: '#fff',
148
- boxShadow: '0 8px 24px rgba(0,0,0,0.25)',
149
- font: `500 12px/1 ${FONT}`,
150
- cursor: 'pointer',
151
- }}
152
- >
153
- <span aria-hidden style={{width: 8, height: 8, borderRadius: 999, background: edit ? '#3ecf8e' : 'rgba(255,255,255,0.45)'}} />
154
- {edit ? labels.editMode : labels.browseMode}
155
- </button>
156
- )
157
- }
158
-
159
79
  /**
160
80
  * Cadres de Sanity à la bonne place. L'overlay mémorise la position de chaque
161
81
  * élément et ne la remesure qu'au redimensionnement : une page qui se décale
@@ -6,7 +6,7 @@
6
6
  * import {annotateImageEditTargets, withPreviewEditTargets, rekeyOwnImageTargets, imageEditAttributes, imageAlt, inheritedEditScriptProps} from '@nocode-factory/sanity-kit/web/edit'
7
7
  * ```
8
8
  *
9
- * Les composants (éditeur, pastille d'image, interrupteur) sont dans
9
+ * Les composants (éditeur, pastille d'image) sont dans
10
10
  * `@nocode-factory/sanity-kit/web` (`NcfPreviewEditing`, `ncfOverlayComponents`).
11
11
  * Dépendances : `@sanity/visual-editing` (fourni par next-sanity).
12
12
  */
@@ -13,10 +13,12 @@ export type PreviewEditingLabels = {
13
13
  inheritedNote: string
14
14
  /** Pastille au survol d'une image. */
15
15
  replaceImage: string
16
- /** Interrupteur du kit (mode `toggle`). */
17
- editMode: string
18
- browseMode: string
19
- modeLabel: string
16
+ /** @deprecated Sans effet depuis 2.67.0 : le kit suit l'interrupteur natif « Edit ». */
17
+ editMode?: string
18
+ /** @deprecated Sans effet depuis 2.67.0. */
19
+ browseMode?: string
20
+ /** @deprecated Sans effet depuis 2.67.0. */
21
+ modeLabel?: string
20
22
  /** Indication sous un texte à plusieurs lignes : Maj + Entrée = retour à la ligne. */
21
23
  newLine: string
22
24
  /** Contrôle automatique : « {n} à vérifier » (éléments non modifiables sur place). */
@@ -33,9 +35,6 @@ export const DEFAULT_PREVIEW_EDITING_LABELS: PreviewEditingLabels = {
33
35
  saved: 'Saved to draft',
34
36
  inheritedNote: 'Component default text: editing it here creates text specific to this page.',
35
37
  replaceImage: 'Replace this image',
36
- editMode: 'Edit mode',
37
- browseMode: 'Browse mode',
38
- modeLabel: 'Preview mode: edit or browse',
39
38
  newLine: 'New line',
40
39
  auditIssues: '{n} to check',
41
40
  auditHelp: 'Elements of this page that cannot be edited in place (click to outline them in red)',
@@ -0,0 +1,97 @@
1
+ import {useEffect} from 'react'
2
+ import {EDIT_MODE_ATTRIBUTE, isEditMode, setOverlayEnabled} from './store'
3
+
4
+ /**
5
+ * Le kit suit l'interrupteur natif « Edit » de Presentation (et ses raccourcis : Alt
6
+ * maintenu, ⌘\ / Ctrl+\).
7
+ *
8
+ * `@sanity/visual-editing` garde l'état pour lui, sans l'exposer, et les messages du
9
+ * Studio ne passent pas tous par la page (constaté : Sanity reçoit la bascule, la page
10
+ * non). On lit donc l'état là où Sanity le montre : « Edit » allumé, Sanity dessine un
11
+ * cadre (invisible hors survol) pour chaque élément modifiable visible, dans
12
+ * `<sanity-visual-editing>` ; éteint, aucun.
13
+ * - un cadre présent = allumé, toujours ;
14
+ * - plus aucun cadre = éteint, sauf juste après un défilement ou un redimensionnement
15
+ * (la zone visible n'a peut-être plus rien de modifiable) : l'état est gardé.
16
+ *
17
+ * Volontairement pas de mémoire ni de rechargement : Sanity rallume « Edit » à chaque
18
+ * chargement de l'aperçu, le kit fait comme lui.
19
+ */
20
+
21
+ /** Après un défilement : la disparition des cadres ne veut pas dire « Edit » éteint. */
22
+ const SCROLL_GRACE_MS = 600
23
+
24
+ /** Aperçu de Presentation : dans son cadre, ou dans la fenêtre qu'il a ouverte. */
25
+ function inStudio(): boolean {
26
+ try {
27
+ return window.self !== window.top || !!window.opener
28
+ } catch {
29
+ return true
30
+ }
31
+ }
32
+
33
+ /** Nombre de cadres dessinés par Sanity (null : Sanity pas encore monté). */
34
+ function overlayCount(): number | null {
35
+ const root = document.querySelector('sanity-visual-editing')?.firstElementChild
36
+ return root ? root.childElementCount : null
37
+ }
38
+
39
+ export function useNativeEditMode() {
40
+ useEffect(() => {
41
+ const root = document.documentElement
42
+ const apply = (edit: boolean) => {
43
+ setOverlayEnabled(edit)
44
+ root.setAttribute(EDIT_MODE_ATTRIBUTE, edit ? 'edit' : 'browse')
45
+ }
46
+ const cleanup = () => {
47
+ root.removeAttribute(EDIT_MODE_ATTRIBUTE)
48
+ setOverlayEnabled(true)
49
+ }
50
+
51
+ // Hors du Studio (préprod ouverte directement) : ni cadres ni « Edit », rien à suivre.
52
+ if (!inStudio()) {
53
+ apply(false)
54
+ return cleanup
55
+ }
56
+
57
+ // Sanity démarre « Edit » allumé.
58
+ apply(true)
59
+ let lastScroll = 0
60
+ let observer: MutationObserver | null = null
61
+
62
+ const read = () => {
63
+ const count = overlayCount()
64
+ if (count === null) return
65
+ let edit = isEditMode()
66
+ if (count > 0) edit = true
67
+ else if (Date.now() - lastScroll > SCROLL_GRACE_MS) edit = false
68
+ if (edit !== isEditMode()) apply(edit)
69
+ }
70
+ const watch = () => {
71
+ const host = document.querySelector('sanity-visual-editing')
72
+ if (!host || observer) return
73
+ observer = new MutationObserver(read)
74
+ observer.observe(host, {childList: true, subtree: true})
75
+ // Juste monté, Sanity n'a encore rien dessiné : ce vide ne veut pas dire éteint.
76
+ lastScroll = Date.now()
77
+ }
78
+ // <sanity-visual-editing> est posé sur <html> par Sanity, parfois après nous.
79
+ const hostObserver = new MutationObserver(watch)
80
+ hostObserver.observe(root, {childList: true})
81
+ watch()
82
+
83
+ const onScroll = () => {
84
+ lastScroll = Date.now()
85
+ }
86
+ window.addEventListener('scroll', onScroll, {passive: true, capture: true})
87
+ window.addEventListener('resize', onScroll)
88
+
89
+ return () => {
90
+ observer?.disconnect()
91
+ hostObserver.disconnect()
92
+ window.removeEventListener('scroll', onScroll, {capture: true})
93
+ window.removeEventListener('resize', onScroll)
94
+ cleanup()
95
+ }
96
+ }, [])
97
+ }
@@ -53,28 +53,26 @@ export const inlineEdit = {
53
53
  /* ------------------------------------------------------------------------- */
54
54
 
55
55
  /**
56
- * « Mode édition » : texte et images se modifient sur place. « Mode visite » : un
57
- * clic suit les liens (cartes, boutons), comme sur le site. Par défaut, le kit
58
- * affiche son interrupteur dans l'aperçu ; un projet peut brancher le sien
59
- * (`editMode` de `NcfPreviewEditing`, ex. un interrupteur d'animations).
56
+ * MODE ÉDITION = l'interrupteur natif « Edit » de Presentation (en haut, à côté de
57
+ * l'adresse), et rien d'autre : le kit n'affiche plus d'interrupteur à lui.
58
+ * - « Edit » allumé : cadres de Sanity, texte et images modifiables sur place, un
59
+ * clic ne suit pas les liens ;
60
+ * - « Edit » éteint (ou touche Alt maintenue, ou ⌘\ / Ctrl+\, comme Sanity) : la
61
+ * page se comporte comme le site, un clic suit les liens.
62
+ * Le kit suit l'état de Sanity dans l'aperçu (useNativeEditMode, nativeEditMode.ts).
60
63
  */
61
64
  export const EDIT_MODE_ATTRIBUTE = 'data-ncf-edit-mode'
62
65
  export const PREVIEW_EDIT_ATTRIBUTE = 'data-ncf-preview-edit'
63
- export const EDIT_MODE_STORAGE_KEY = 'ncf-preview-mode'
64
66
 
65
- const defaultEditMode = () => typeof document !== 'undefined' && document.documentElement.getAttribute(EDIT_MODE_ATTRIBUTE) !== 'browse'
66
- let editModeResolver: () => boolean = defaultEditMode
67
+ // « Edit » de Presentation, suivi par useNativeEditMode. Sanity le démarre allumé.
68
+ let overlayEnabled = true
67
69
 
68
- export function setEditModeResolver(resolver: (() => boolean) | null) {
69
- editModeResolver = resolver ?? defaultEditMode
70
+ export function setOverlayEnabled(enabled: boolean) {
71
+ overlayEnabled = enabled
70
72
  }
71
73
 
72
74
  export function isEditMode(): boolean {
73
- try {
74
- return editModeResolver()
75
- } catch {
76
- return false
77
- }
75
+ return overlayEnabled
78
76
  }
79
77
 
80
78
  /* ------------------------------------------------------------------------- */