github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2024-11-25 08:00:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix typing errors with app.modal.show

Browse Source 
Unfortunately TypeScript doesn't support higher-kinded types, so we can't write this in a type-safe way.
This commit is contained in:
Alexander Skvortsov 2021-12-12 22:38:55 -05:00
parent 850d555866
commit 7b8eaf9045
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
framework/core/js/src/common/states/ModalManagerState.ts
View File

@ -1,5 +1,15 @@
import Component from '../Component';
import Modal from '../components/Modal';
/**
* Ideally, `show` would take a higher-kinded generic, ala:
* `show<Attrs, C>(componentClass: C<Attrs>, attrs: Attrs): void`
* Unfortunately, TypeScript does not support this:
* https://github.com/Microsoft/TypeScript/issues/1213
* Therefore, we have to use this ugly, messy workaround.
*/
type UnsafeModalClass = ComponentClass<any, Modal> & {isDismissible: boolean, component: typeof Component.component};
/**
* Class used to manage modal state.
*
@ -10,7 +20,7 @@ export default class ModalManagerState {
* @internal
*/
modal: null | {
componentClass: typeof Modal;
componentClass: UnsafeModalClass;
attrs?: Record<string, unknown>;
} = null;
@ -28,7 +38,7 @@ export default class ModalManagerState {
* // This "hack" is needed due to quirks with nested redraws in Mithril.
* setTimeout(() => app.modal.show(MyCoolModal, { attr: 'value' }), 0);
*/
show(componentClass: typeof Modal, attrs: Record<string, unknown> = {}): void {
show(componentClass: UnsafeModalClass, attrs: Record<string, unknown> = {}): void {
if (!(componentClass.prototype instanceof Modal)) {
// This is duplicated so that if the error is caught, an error message still shows up in the debug console.
const invalidModalWarning = 'The ModalManager can only show Modals.';