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.

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

feat: fiori types folder to TypeScript #6076

Merged
merged 8 commits into from
Nov 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 0 additions & 54 deletions packages/fiori/src/types/BarDesign.js

This file was deleted.

38 changes: 38 additions & 0 deletions packages/fiori/src/types/BarDesign.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/**
* @class
* @enum {string}
* @public
hinzzx marked this conversation as resolved.
Show resolved Hide resolved
* @author SAP SE
* @alias sap.ui.webcomponents.fiori.types.BarDesign
*/
enum BarDesign {
/**
* Default type
* @public
* @type {Header}
*/
Header = "Header",

/**
* Subheader type
* @public
* @type {Subheader}
*/
Subheader = "Subheader",

/**
* Footer type
* @public
* @type {Footer}
*/
Footer = "Footer",

/**
* Floating Footer type - there is visible border on all sides
* @public
* @type {FloatingFooter}
*/
FloatingFooter = "FloatingFooter",
}

export default BarDesign;
134 changes: 0 additions & 134 deletions packages/fiori/src/types/FCLLayout.js

This file was deleted.

118 changes: 118 additions & 0 deletions packages/fiori/src/types/FCLLayout.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
/**
* Different types of FCLLayout.
*
* @class
* @enum {string}
* @public
* @author SAP SE
* @alias sap.ui.webcomponents.fiori.types.FCLLayout
*/
enum FCLLayout {
/**
* The layout will display 1 column.
* @public
* @type {OneColumn}
*/
OneColumn = "OneColumn",

/**
*
* Desktop: 67 - 33 - -- Start (expanded) and Mid columns are displayed
* Tablet: 67 - 33 - -- Start (expanded) and Mid columns are displayed
* Phone: -- 100 -- only the Mid column is displayed
*
* Use to display both a list and a detail page when the user should focus on the list page.
*
* @type {TwoColumnsStartExpanded}
* @public
*/
TwoColumnsStartExpanded = "TwoColumnsStartExpanded",

/**
* Desktop: 33 - 67 - -- Start and Mid (expanded) columns are displayed
* Tablet: 33 - 67 - -- Start and Mid (expanded) columns are displayed
* Phone: -- 100 -- only the Mid column is displayed
*
* Use to display both a list and a detail page when the user should focus on the detail page.
*
* @type {TwoColumnsMidExpanded}
* @public
*/
TwoColumnsMidExpanded = "TwoColumnsMidExpanded",

/**
* Desktop: 25 - 50 - 25 Start, Mid (expanded) and End columns are displayed
* Tablet: 0 - 67 - 33 Mid (expanded) and End columns are displayed, Start is accessible by a layout arrow
* Phone: -- -- 100 only the End column is displayed
*
* Use to display all three pages (list, detail, detail-detail) when the user should focus on the detail.
*
* @type {ThreeColumnsMidExpanded}
* @public
*/
ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",

/**
* Desktop: 25 - 25 - 50 Start, Mid and End (expanded) columns are displayed
* Tablet: 0 - 33 - 67 Mid and End (expanded) columns are displayed, Start is accessible by layout arrows
* Phone: -- -- 100 (only the End column is displayed)
*
* Use to display all three pages (list, detail, detail-detail) when the user should focus on the detail-detail.
*
* @public
* @type ThreeColumnsEndExpanded
*/
ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",

/**
* Desktop: 67 - 33 - 0 Start (expanded) and Mid columns are displayed, End is accessible by layout arrows
* Tablet: 67 - 33 - 0 Start (expanded) and Mid columns are displayed, End is accessible by layout arrows
* Phone: -- -- 100 only the End column is displayed
*
* Use to display the list and detail pages when the user should focus on the list.
* The detail-detail is still loaded and easily accessible with layout arrows.
*
* @public
* @type ThreeColumnsStartExpandedEndHidden
*/
ThreeColumnsStartExpandedEndHidden = "ThreeColumnsStartExpandedEndHidden",

/**
* Desktop: 33 - 67 - 0 Start and Mid (expanded) columns are displayed, End is accessible by a layout arrow
* Tablet: 33 - 67 - 0 Start and Mid (expanded) columns are displayed, End is accessible by a layout arrow
* Phone: -- -- 100 only the End column is displayed
*
* Use to display the list and detail pages when the user should focus on the detail.
* The detail-detail is still loaded and easily accessible with a layout arrow.
*
* @public
* @type ThreeColumnsMidExpandedEndHidden
*/
ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",

/**
* Desktop: -- 100 -- only the Mid column is displayed
* Tablet: -- 100 -- only the Mid column is displayed
* Phone: -- 100 -- only the Mid column is displayed
*
* Use to display a detail page only, when the user should focus entirely on it.
*
* @public
* @type MidColumnFullScreen
*/
MidColumnFullScreen = "MidColumnFullScreen",

/**
* Desktop: -- -- 100 only the End column is displayed
* Tablet: -- -- 100 only the End column is displayed
* Phone: -- -- 100 only the End column is displayed
*
* Use to display a detail-detail page only, when the user should focus entirely on it.
*
* @public
* @type EndColumnFullScreen
*/
EndColumnFullScreen = "EndColumnFullScreen",
}

export default FCLLayout;
Loading