@furo/layout
Version:
Layout components for furo
44 lines (43 loc) • 1.53 kB
TypeScript
import * as React from "react";
export interface FuroBackdropDisplay extends React.HTMLAttributes<HTMLElement> {
/**
* Indicates that the backdrop is shown.
*/
show?: boolean;
/**
* Needed to start the animation.
*/
start?: boolean;
/**
* Timeout duration, to wait to notify the changes.
*
* Note: the animations in the css are set with 250ms.
*
* If you are interested to use at-opened to load some data, set this value lower. This gives you 250 ms extra time to load content, without feeling slow.
*
* If you are interested to use at-opened to show some ui stuff, set this value higher or equal 250.
*/
toDuration?: number;
}
declare module "react" {
namespace JSX {
interface IntrinsicElements {
/**
* `furo-backdrop-display`
*
* This components receives and displays the backdrop requests from furo-backdrop components.
*
* The backdrop display can be placed anywhere in the dom. The higher the better.
*
* Tipp: place it below or inside the component which applies the style vars. Othewise the displayed components
* do not know these vars.
*
* ```html
* <!-- place the display in your main-stage -->
* <furo-backdrop-display></furo-backdrop-display>
* ```
*/
"furo-backdrop-display": FuroBackdropDisplay;
}
}
}