Skip to main content

Type Alias: AdwBannerProps

AdwBannerProps = WidgetProps & object

Defined in: generated/jsx.ts:1805

Props for the AdwBanner widget.

Type Declaration

NameTypeDescriptionDefined in
actionName?stringThe name of the action with which this widget should be associated.generated/jsx.ts:1839
actionTarget?GLib.VariantThe target value of the actionable widget's action.generated/jsx.ts:1841
buttonLabel?string | nullThe label to show on the button. If set to "" or NULL, the button won't be shown. The button can be used with a GAction, or with the AdwBanner.:button-clicked signal.generated/jsx.ts:1814
buttonStyle?Adw.BannerButtonStyleThe style class to use for the banner button. When set to ADW_BANNER_BUTTON_DEFAULT, the button stays grey. When set to ADW_BANNER_BUTTON_SUGGESTED, the button follows the .suggested-action style banner with suggested button stylegenerated/jsx.ts:1823
onButtonClicked()?(self) => void | nullThis signal is emitted after the action button has been clicked. It can be used as an alternative to setting an action.generated/jsx.ts:1847
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:1853
ref?Ref<Adw.Banner>-generated/jsx.ts:1866
revealed?booleanWhether the banner is currently revealed.generated/jsx.ts:1825
titlestringThe title for this banner. See also: AdwBanner.use-markup.generated/jsx.ts:1831
useMarkup?booleanWhether to use Pango markup for the banner title. See also Pangoparse_markup.generated/jsx.ts:1837