Refactor #3879 - For Terminal

This commit is contained in:
Tuğçe Küçükoğlu 2023-04-24 11:08:08 +03:00
parent 7dfa8eb0f4
commit 4db6f0ff43
3 changed files with 97 additions and 10 deletions

View file

@ -9,6 +9,80 @@
*/
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export declare type TerminalPassThroughOptionType = TerminalPassThroughAttributes | ((options: TerminalPassThroughMethodOptions) => TerminalPassThroughAttributes) | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface TerminalPassThroughMethodOptions {
props: TerminalProps;
state: TerminalState;
}
/**
* Custom passthrough(pt) options.
* @see {@link TerminalProps.pt}
*/
export interface TerminalPassThroughOptions {
/**
* Uses to pass attributes to the root's DOM element.
*/
root?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the welcome message's DOM element.
*/
welcomeMessage?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the content's DOM element.
*/
content?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the commands' DOM element.
*/
commands?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the prompt's DOM element.
*/
prompt?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the command's DOM element.
*/
command?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the response's DOM element.
*/
response?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the container's DOM element.
*/
container?: TerminalPassThroughOptionType;
/**
* Uses to pass attributes to the command text's DOM element.
*/
commandText?: TerminalPassThroughOptionType;
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface TerminalPassThroughAttributes {
[key: string]: any;
}
/**
* Defines current inline state in Terminal component.
*/
export interface TerminalState {
/**
* Current command text as a string.
*/
commandText: string;
/**
* Current commands as an array.
*/
commands: string[];
}
/**
* Defines valid properties in Terminal component.
*/
@ -21,6 +95,11 @@ export interface TerminalProps {
* Prompt text for each command.
*/
prompt?: string | undefined;
/**
* Uses to pass attributes to DOM elements inside the component.
* @type {TerminalPassThroughOptions}
*/
pt?: TerminalPassThroughOptions;
}
/**