primevue-mirror/components/lib/terminal/Terminal.d.ts

147 lines
3.6 KiB
TypeScript
Raw Normal View History

2023-03-01 14:13:26 +00:00
/**
*
* Terminal is a text based user interface.
*
* [Live Demo](https://www.primevue.org/terminal)
*
* @module terminal
*
*/
2023-07-06 11:17:08 +00:00
import { ComponentHooks } from '../basecomponent';
2022-09-06 12:03:37 +00:00
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-04-24 08:08:08 +00:00
export declare type TerminalPassThroughOptionType = TerminalPassThroughAttributes | ((options: TerminalPassThroughMethodOptions) => TerminalPassThroughAttributes) | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface TerminalPassThroughMethodOptions {
2023-07-06 12:01:33 +00:00
instance: any;
2023-04-24 08:08:08 +00:00
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;
2023-07-06 11:09:01 +00:00
/**
* Uses to manage all lifecycle hooks
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
2023-04-24 08:08:08 +00:00
}
/**
* 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[];
}
2023-03-01 14:13:26 +00:00
/**
* Defines valid properties in Terminal component.
*/
2022-09-06 12:03:37 +00:00
export interface TerminalProps {
/**
* Initial text to display on terminal.
*/
welcomeMessage?: string | undefined;
/**
* Prompt text for each command.
*/
prompt?: string | undefined;
2023-04-24 08:08:08 +00:00
/**
* Uses to pass attributes to DOM elements inside the component.
* @type {TerminalPassThroughOptions}
*/
pt?: TerminalPassThroughOptions;
2023-05-24 12:53:29 +00:00
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
2022-09-06 12:03:37 +00:00
}
2023-03-01 14:13:26 +00:00
/**
* Defines valid slots in Terminal component.
*/
2022-09-14 11:26:01 +00:00
export interface TerminalSlots {}
2022-09-06 12:03:37 +00:00
2023-03-01 14:13:26 +00:00
/**
* Defines valid emits in Terminal component.
*/
export interface TerminalEmits {}
2022-09-06 12:03:37 +00:00
2023-03-01 14:13:26 +00:00
/**
* **PrimeVue - Terminal**
*
* _Terminal is a text based user interface._
*
* [Live Demo](https://www.primevue.org/terminal/)
* --- ---
* ![Primevue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
2022-09-14 11:26:01 +00:00
declare class Terminal extends ClassComponent<TerminalProps, TerminalSlots, TerminalEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
Terminal: GlobalComponentConstructor<Terminal>;
2022-09-06 12:03:37 +00:00
}
}
export default Terminal;