@limetech/lime-elements
Version:
47 lines • 1.58 kB
TypeScript
import { OpenDirection } from '../menu/menu.types';
import { Help } from '../help/help.types';
import { Link } from '../../global/shared-types/link.types';
/**
* A good design is self-explanatory! However, sometimes concepts are
* too complex to understand, no matter how well-designed a user interface is.
* In such cases, contextual help can be a great way to provide users with
* help precisely where and when users need it.
*
* In app interface design, providing contextual help emerges as a viable practice
* for enhancing user experience and usability.
* Contextual help serves as a quick-to-access guiding,
* empowering users to more easily understand and navigate through
* the intricacies of an application.
*
* Using this component designers empower users to grasp the functionality
* of an app more effortlessly, minimizes the learning curve,
* transforming complex features into accessible opportunities for exploration.
*
* @exampleComponent limel-example-help
* @exampleComponent limel-example-read-more
* @exampleComponent limel-example-open-direction
* @exampleComponent limel-example-placement
*/
export declare class HelpComponent implements Help {
/**
* {@inheritdoc Help.value}
*/
value: string;
/**
* {@inheritdoc Help.trigger}
*/
trigger: string;
/**
* {@inheritdoc Help.readMoreLink}
*/
readMoreLink?: Link;
/**
* {@inheritdoc Help.openDirection}
*/
openDirection: OpenDirection;
private isOpen;
render(): any[];
private openPopover;
private onPopoverClose;
}
//# sourceMappingURL=help.d.ts.map