chore: Updating hooks docs for v3
This commit is contained in:
parent
098d23c3b7
commit
2c12227ea8
14 changed files with 288 additions and 47 deletions
27
markdown/dev/reference/api/hooks/prepartdraft/en.md
Normal file
27
markdown/dev/reference/api/hooks/prepartdraft/en.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: prePartDraft
|
||||
---
|
||||
|
||||
The `prePartDraft` lifecycle hook runs just before a part is drafted.
|
||||
It will fire once for each part in each set (of settings).
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
null hook(Pattern pattern)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```js
|
||||
pattern.on('prePartDraft', pattern => {
|
||||
// Mutate the pattern object here
|
||||
// You can use the pattern.activePart
|
||||
// and pattern.activeSet properties to
|
||||
// figure out for which part this hook was fired
|
||||
}
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
The `prePartDraft` hook is rarely used, but it's there if you need it.
|
Loading…
Add table
Add a link
Reference in a new issue