Refactor Payloads

pull/21833/head
Jorik Schellekens 2020-05-25 18:11:55 +01:00
parent fc1f14f5aa
commit 035c4fae50
3 changed files with 36 additions and 18 deletions

View File

@ -40,7 +40,7 @@ export enum Action {
ViewUserSettings = "view_user_settings", ViewUserSettings = "view_user_settings",
/** /**
* Sets the current tooltip * Sets the current tooltip. Should be use with ViewTooltipPayload.
*/ */
ViewTooltip = "view_tooltip", ViewTooltip = "view_tooltip",
} }

View File

@ -0,0 +1,35 @@
/*
Copyright 2020 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { ActionPayload } from "../payloads";
import { Action } from "../actions";
import { Component } from "react";
export interface ViewTooltipPayload extends ActionPayload {
action: Action.ViewTooltip,
/*
* The tooltip to render. If it's null the tooltip will not be rendered
* We need the void type because of typescript headaches.
*/
tooltip: null | void | Element | Component<Element, any, any>;
/*
* The parent under which to render the tooltip. Can be null to remove
* the parent type.
*/
parent: null | Element
}

View File

@ -17,7 +17,6 @@ limitations under the License.
import { RoomMember } from "matrix-js-sdk/src/models/room-member"; import { RoomMember } from "matrix-js-sdk/src/models/room-member";
import { ActionPayload } from "../payloads"; import { ActionPayload } from "../payloads";
import { Action } from "../actions"; import { Action } from "../actions";
import { Component } from "react";
export interface ViewUserPayload extends ActionPayload { export interface ViewUserPayload extends ActionPayload {
action: Action.ViewUser, action: Action.ViewUser,
@ -28,19 +27,3 @@ export interface ViewUserPayload extends ActionPayload {
*/ */
member?: RoomMember; member?: RoomMember;
} }
export interface ViewTooltipPayload extends ActionPayload {
action: Action.ViewTooltip,
/*
* The tooltip to render. If it's null the tooltip will not be rendered
* We need the void type because of typescript headaches.
*/
tooltip: null | void | Element | Component<Element, any, any>;
/*
* The parent under which to render the tooltip. Can be null to remove
* the parent type.
*/
parent: null | Element
}