Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Block Definition added full parameter list and fixed a typo #60

Merged
merged 2 commits into from
Sep 9, 2024
Merged

Documentation Block Definition added full parameter list and fixed a typo #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
484ddd6
Update BlockCreation.md
mrredo Sep 9, 2024
f77a0e5
Update BlockCreation.md
mrredo Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/blocks/BlockCreation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,17 @@ type BlockDefinition = {
helpUrl: string;
// The block's code, with all the arguments passed in the "args" param
code: (args: Record<string, unknown>) => unknown;
// The blocks mutator(the gear icon located at the left top corner in the block)
mutator?: Mutator;
// Hides the block from category, but still have it registered as a block.
// Mostly used for mutator blocks that are inside the mutator menu
hidden?: boolean;
// List of library imports that block requires.
imports?: `${string}@${string}`[];
};
```

So considering that most of the paramters are not required, here is the minimum configuration for a block :
So considering that most of the parameters are not required, here is the minimum configuration for a block :

```ts
type BlockDefinition = {
Expand Down
Loading