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

Jump to bottom

docs(ui5-page): improve documentation #7919

Merged
merged 1 commit into from
Nov 29, 2023
Merged

docs(ui5-page): improve documentation #7919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 7 additions & 35 deletions packages/fiori/src/Page.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,15 @@ import PageCss from "./generated/themes/Page.css.js";
* that there is enough space for the <code>ui5-page</code> to be rendered.
* <b>Note:</b> In order for the <code>ui5-page</code> to be displayed, the parent element should have fixed height.
*
* <h3>CSS Shadow Parts</h3>
*
* <ui5-link target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/CSS/::part">CSS Shadow Parts</ui5-link> allow developers to style elements inside the Shadow DOM.
* <br>
* The <code>ui5-page</code> exposes the following CSS Shadow Parts:
* <ul>
* <li>content - Used to style the content section of the component</li>
* </ul>
*
* <h3>ES6 Module Import</h3>
*
* <code>import "@ui5/webcomponents-fiori/dist/Page.js";</code>
*
* @constructor
* @author SAP SE
* @alias sap.ui.webc.fiori.Page
* @extends sap.ui.webc.base.UI5Element
* @tagname ui5-page
* @extends UI5Element
* @since 1.0.0-rc.12
* @public
* @csspart content - Used to style the content section of the component
*/
@customElement({
tag: "ui5-page",
Expand All @@ -74,9 +63,7 @@ class Page extends UI5Element {
* <b>Note:</b> When a ui5-list is placed inside the page, we recommend using “List” to ensure better color contrast.
* <br><br>
*
* @type {sap.ui.webc.fiori.types.PageBackgroundDesign}
* @name sap.ui.webc.fiori.Page.prototype.backgroundDesign
* @defaultvalue "Solid"
* @default "Solid"
* @public
*/
@property({ type: PageBackgroundDesign, defaultValue: PageBackgroundDesign.Solid })
Expand All @@ -86,9 +73,7 @@ class Page extends UI5Element {
* Disables vertical scrolling of page content.
* If set to true, there will be no vertical scrolling at all.
*
* @type {boolean}
* @name sap.ui.webc.fiori.Page.prototype.disableScrolling
* @defaultvalue false
* @default false
* @public
*/
@property({ type: Boolean })
Expand All @@ -98,9 +83,8 @@ class Page extends UI5Element {
* Defines if the footer should float over the content.
* <br><br>
* <b>Note:</b> When set to true the footer floats over the content with a slight offset from the bottom, otherwise it is fixed at the very bottom of the page.
* @type {boolean}
* @name sap.ui.webc.fiori.Page.prototype.floatingFooter
* @defaultvalue true
*
* @default true
* @public
*/
@property({ type: Boolean })
Expand All @@ -109,9 +93,7 @@ class Page extends UI5Element {
/**
* Defines the footer visibility.
*
* @type {boolean}
* @name sap.ui.webc.fiori.Page.prototype.hideFooter
* @defaultvalue false
* @default false
* @public
*/
@property({ type: Boolean })
Expand All @@ -120,7 +102,6 @@ class Page extends UI5Element {
/**
* Defines the current media query size.
*
* @type {string}
* @private
* @since 1.0.0-rc.15
*/
Expand All @@ -130,9 +111,6 @@ class Page extends UI5Element {
/**
* Defines the header HTML Element.
*
* @type {sap.ui.webc.fiori.IBar}
* @name sap.ui.webc.fiori.Page.prototype.header
* @slot
* @public
*/
@slot()
Expand All @@ -141,9 +119,6 @@ class Page extends UI5Element {
/**
* Defines the content HTML Element.
*
* @type {HTMLElement[]}
* @name sap.ui.webc.fiori.Page.prototype.default
* @slot content
* @public
*/
@slot({ type: HTMLElement, "default": true })
Expand All @@ -152,9 +127,6 @@ class Page extends UI5Element {
/**
* Defines the footer HTML Element.
*
* @type {sap.ui.webc.fiori.IBar}
* @name sap.ui.webc.fiori.Page.prototype.footer
* @slot
* @public
*/
@slot()
Expand Down
7 changes: 0 additions & 7 deletions packages/fiori/src/types/PageBackgroundDesign.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,27 @@
/**
* Available Page Background Design.
*
* @readonly
* @enum {string}
* @public
* @author SAP SE
* @alias sap.ui.webc.fiori.types.PageBackgroundDesign
*/
enum PageBackgroundDesign {

/**
* Page background color when a List is set as the Page content.
*
* @type {List}
* @public
*/
List = "List",

/**
* A solid background color dependent on the theme.
*
* @type {Solid}
* @public
*/
Solid = "Solid",

/**
* Transparent background for the page.
*
* @type {Transparent}
* @public
*/
Transparent = "Transparent",
Expand Down
Loading