Skip to main content

Type Alias: AdwAboutDialogProps

AdwAboutDialogProps = Omit<AdwDialogProps, "onNotify"> & object

Defined in: generated/jsx.ts:532

Props for the AdwAboutDialog widget.

Type Declaration​

NameTypeDescriptionDefined in
applicationIcon?stringThe name of the application icon. The icon is displayed at the top of the main page.generated/jsx.ts:538
applicationName?stringThe name of the application. The name is displayed at the top of the main page.generated/jsx.ts:544
artists?string[] | nullThe list of artists of the application. It will be displayed on the Credits page. Each name may contain email addresses and URLs, see the introduction for more details. See also: * AdwAboutDialog.developers * AdwAboutDialog.designers * AdwAboutDialog.documenters * AdwAboutDialog.translator-credits * AboutDialogadd_credit_section * AboutDialogadd_acknowledgement_sectiongenerated/jsx.ts:562
children?ReactNode-generated/jsx.ts:814
comments?stringThe comments about the application. Comments will be shown on the Details page, above links. Unlike AboutDialog.comments, this string can be long and detailed. It can also contain links and Pango markup.generated/jsx.ts:571
copyright?stringThe copyright information. This should be a short string of one or two lines, for example: © 2022 Example. The copyright information will be displayed on the Legal page, above the application license. AboutDialogadd_legal_section can be used to add copyright information for the application dependencies or other components.generated/jsx.ts:584
debugInfo?stringThe debug information. Debug information will be shown on the Troubleshooting page. It's intended to be attached to issue reports when reporting issues against the application. AdwAboutDialog provides a quick way to save debug information to a file. When saving, AdwAboutDialog.debug-info-filename would be used as the suggested filename. Debug information cannot contain markup or links.generated/jsx.ts:598
debugInfoFilename?stringThe debug information filename. It will be used as the suggested filename when saving debug information to a file. See AdwAboutDialog.debug-info.generated/jsx.ts:607
designers?string[] | nullThe list of designers of the application. It will be displayed on the Credits page. Each name may contain email addresses and URLs, see the introduction for more details. See also: * AdwAboutDialog.developers * AdwAboutDialog.artists * AdwAboutDialog.documenters * AdwAboutDialog.translator-credits * AboutDialogadd_credit_section * AboutDialogadd_acknowledgement_sectiongenerated/jsx.ts:625
developerName?stringThe developer name. The developer name is displayed on the main page, under the application name. If the application is developed by multiple people, the developer name can be set to values like "AppName team", "AppName developers" or "The AppName project", and the individual contributors can be listed on the Credits page, with AdwAboutDialog.developers and related properties.generated/jsx.ts:638
developers?string[] | nullThe list of developers of the application. It will be displayed on the Credits page. Each name may contain email addresses and URLs, see the introduction for more details. See also: * AdwAboutDialog.designers * AdwAboutDialog.artists * AdwAboutDialog.documenters * AdwAboutDialog.translator-credits * AboutDialogadd_credit_section * AboutDialogadd_acknowledgement_sectiongenerated/jsx.ts:656
documenters?string[] | nullThe list of documenters of the application. It will be displayed on the Credits page. Each name may contain email addresses and URLs, see the introduction for more details. See also: * AdwAboutDialog.developers * AdwAboutDialog.designers * AdwAboutDialog.artists * AdwAboutDialog.translator-credits * AboutDialogadd_credit_section * AboutDialogadd_acknowledgement_sectiongenerated/jsx.ts:674
issueUrl?stringThe URL for the application's issue tracker. The issue tracker link is displayed on the main page.generated/jsx.ts:680
license?stringThe license text. This can be used to set a custom text for the license if it can't be set via AdwAboutDialog.license-type. When set, AdwAboutDialog.license-type will be set to GTK_LICENSE_CUSTOM. The license text will be displayed on the Legal page, below the copyright information. License text can contain Pango markup and links. AboutDialogadd_legal_section can be used to add license information for the application dependencies or other components.generated/jsx.ts:698
licenseType?Gtk.LicenseThe license type. Allows to set the application's license froma list of known licenses. If the application's license is not in the list, AdwAboutDialog.license can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case. If set to GTK_LICENSE_UNKNOWN, no information will be displayed. If the license type is different from GTK_LICENSE_CUSTOM. AdwAboutDialog.license will be cleared out. The license description will be displayed on the Legal page, below the copyright information. AboutDialogadd_legal_section can be used to add license information for the application dependencies or other components.generated/jsx.ts:719
onActivateLink()?(self, uri) => boolean | nullEmitted when a URL is activated. Applications may connect to it to override the default behavior, which is to call show_uri.generated/jsx.ts:813
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:820
ref?Ref<Adw.AboutDialog>-generated/jsx.ts:846
releaseNotes?stringThe release notes of the application. Release notes are displayed on the the What's New page. Release notes are formatted the same way as AppStream descriptions. The supported formatting options are: * Paragraph (<p>) * Ordered list (<ol>), with list items (<li>) * Unordered list (<ul>), with list items (<li>) Within paragraphs and list items, emphasis (<em>) and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font. Any text outside paragraphs or list items is ignored. Nested lists are not supported. AdwAboutDialog displays the version above the release notes. If set, the AdwAboutDialog.release-notes-version of the property will be used as the version; otherwise, AdwAboutDialog.version is used.generated/jsx.ts:746
releaseNotesVersion?stringThe version described by the application's release notes. The release notes version is displayed on the What's New page, above the release notes. If not set, AdwAboutDialog.version will be used instead. For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly. See AdwAboutDialog.release-notes.generated/jsx.ts:761
supportUrl?stringThe URL of the application's support page. The support page link is displayed on the main page.generated/jsx.ts:767
translatorCredits?stringThe translator credits string. It will be displayed on the Credits page. This string should be "translator-credits" or "translator_credits" and should be marked as translatable. The string may contain email addresses and URLs, see the introduction for more details. See also: * AdwAboutDialog.developers * AdwAboutDialog.designers * AdwAboutDialog.artists * AdwAboutDialog.documenters * AboutDialogadd_credit_section * AboutDialogadd_acknowledgement_sectiongenerated/jsx.ts:788
version?stringThe version of the application. The version is displayed on the main page. If AdwAboutDialog.release-notes-version is not set, the version will also be displayed above the release notes on the What's New page.generated/jsx.ts:797
website?stringThe URL of the application's website. Website is displayed on the Details page, below comments, or on the main page if the Details page doesn't have any other content. Applications can add other links below, see AboutDialogadd_link.generated/jsx.ts:806