Skip to content

chore(modal): update d.ts for showModal(...) parameters #5734

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

Merged
manoldonev merged 3 commits into from
Apr 25, 2018
Merged

chore(modal): update d.ts for showModal(...) parameters #5734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba73566
chore(modal): update dts for showModal(...) args
manoldonev Apr 24, 2018
4c42951
Merge branch 'master' into mdonev/show-modal-dts
manoldonev Apr 25, 2018
75b1b8b
Merge branch 'master' into mdonev/show-modal-dts
manoldonev Apr 25, 2018
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
10 changes: 7 additions & 3 deletions tns-core-modules/ui/core/view-base/view-base.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,18 +116,22 @@ export abstract class ViewBase extends Observable {
* This same context will be available in the arguments of the shownModally event handler.
* @param closeCallback - A function that will be called when the view is closed.
* Any arguments provided when calling ShownModallyData.closeCallback will be available here.
* @param fullscreen - An optional parameter specifying whether to show the modal page in full-screen mode.
* @param fullscreen - An optional parameter specifying whether to show the modal view in full-screen mode.
* @param animated - An optional parameter specifying whether to show the modal view with animation.
* @param stretched - An optional parameter specifying whether to stretch the modal view when not in full-screen mode.
*/
showModal(moduleName: string, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean): ViewBase;
showModal(moduleName: string, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): ViewBase;

/**
* Shows the view passed as parameter as a modal view.
* @param view - View instance to be shown modally.
* @param context - Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.
* @param closeCallback - A function that will be called when the view is closed. Any arguments provided when calling ShownModallyData.closeCallback will be available here.
* @param fullscreen - An optional parameter specifying whether to show the modal view in full-screen mode.
* @param animated - An optional parameter specifying whether to show the modal view with animation.
* @param stretched - An optional parameter specifying whether to stretch the modal view when not in full-screen mode.
*/
showModal(view: ViewBase, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean): ViewBase;
showModal(view: ViewBase, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): ViewBase;

/**
* Deprecated. Showing view as modal is deprecated.
Expand Down
33 changes: 0 additions & 33 deletions tns-core-modules/ui/core/view/view.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,39 +506,6 @@ export abstract class View extends ViewBase {
*/
on(event: "shownModally", callback: (args: ShownModallyData) => void, thisArg?: any);

/**
* Shows the View contained in moduleName as a modal view.
* @param moduleName - The name of the module to load starting from the application root.
* @param context - Any context you want to pass to the modally shown view.
* This same context will be available in the arguments of the shownModally event handler.
* @param closeCallback - A function that will be called when the view is closed.
* Any arguments provided when calling ShownModallyData.closeCallback will be available here.
* @param fullscreen - An optional parameter specifying whether to show the modal page in full-screen mode.
* @param stretched - An optional parameter specifying whether to stretch the modal page when not in full-screen mode.
*/
showModal(moduleName: string, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): View;

/**
* Shows the view passed as parameter as a modal view.
* @param view - View instance to be shown modally.
* @param context - Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.
* @param closeCallback - A function that will be called when the view is closed. Any arguments provided when calling ShownModallyData.closeCallback will be available here.
* @param fullscreen - An optional parameter specifying whether to show the modal view in full-screen mode.
* @param stretched - An optional parameter specifying whether to stretch the modal page when not in full-screen mode.
*/
showModal(view: View, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): View;

/**
* Deprecated. Showing view as modal is deprecated.
* Use showModal method with arguments.
*/
showModal(): View;

/**
* Closes the current modal view that this page is showing.
*/
closeModal(): void;

/**
* Returns the current modal view that this page is showing (is parent of), if any.
*/
Expand Down