From 235f2313c80282300d21d358afeccb7977485b57 Mon Sep 17 00:00:00 2001 From: Lennard Hofmann Date: Sat, 30 Dec 2023 13:49:23 +0100 Subject: [PATCH] [docs] document conditional custom context panes This feature was added in #866 --- docs/api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 733d245f0..12c1ce97d 100644 --- a/docs/api.md +++ b/docs/api.md @@ -101,11 +101,12 @@ near the bottom of the context. The order can be modified in the `GEF` context c ### Context Pane API The API demonstrated above requires very specific argument types: -`register_external_context_pane(pane_name, display_pane_function, pane_title_function)` +`register_external_context_pane(pane_name, display_pane_function, pane_title_function, condition=None)` * `pane_name`: a string that will be used as the panes setting name * `display_pane_function`: a function that uses `gef_print()` to print content in the pane * `pane_title_function`: a function that returns the title string or None to hide the title +* `condition` (optional): a function that returns whether this context pane should be shown ## API