Composants → bpm.sidebar

bpm.sidebar

Décorateur qui enregistre une fonction comme contenu de la barre latérale. La fonction peut appeler d'autres composants BPM (liens, titres, boutons, etc.) pour constituer le contenu de la sidebar.

StableNavigation⏱ 2 min

Usage

Décorez une fonction avec @bpm.sidebar. Lors de l'exécution de l'app (bpm run app.py), le moteur de rendu peut récupérer cette fonction via bpm.get_registered("sidebar") et afficher son contenu dans une colonne latérale.

Exemples

@bpm.sidebar
def my_sidebar():
    bpm.title("Menu", level=3)
    bpm.write("Accueil")
    bpm.write("Paramètres")
    bpm.button("Déconnexion")
# Enregistrement : la fonction est appelée au chargement de l'app
# Le layout (CLI / frontend) utilise bpm.get_registered("sidebar") pour
# récupérer la fonction et afficher ses nœuds dans la barre latérale.
ÉlémentDescription
@bpm.sidebarDécorateur à appliquer à une fonction sans arguments. La fonction est enregistrée sous le nom "sidebar".
bpm.get_registered("sidebar")Retourne la fonction enregistrée (ou None). Le moteur de rendu l'appelle pour obtenir les nœuds à afficher dans la sidebar.

Intégration layout

Le CLI BPM (bpm run app.py) et les frontends qui consomment les nœuds peuvent vérifier la présence d'une sidebar enregistrée et générer une mise en page à deux colonnes : sidebar (contenu de la fonction décorée) + zone principale (contenu du script).