@nodegui/vue-nodegui
Version:
library to render native desktop applications using vue js
61 lines (60 loc) • 2.41 kB
TypeScript
import { QScrollArea, NodeWidget } from '@nodegui/nodegui';
import { VNWidget } from 'widgets/config';
import { PropSetters, Prop } from '../../renderer/patchProp';
import { ViewProps } from '../View/VNView';
/**
* The scroll-area widget allows users to wrap other widgets to enable a scroll
* (horizontal and vertical).
* It is based on [NodeGui's QScrollArea](https://docs.nodegui.org/docs/api/generated/classes/qscrollarea)
*
* > Note that the scroll area only allows one child. So, you may have to wrap contents in a vn-view
*
* ## Usage
*
* ```html
* <template>
* <vn-scroll-area>
* <vn-view :style="'flex-direction: \'column\''">
* <vn-text>Hello world</vn-text>
* <vn-text :wordWrap="true">
* Lorem ipsum dolor sit amet, consectetur adipiscing elit.
* Donec sapien orci, mattis sed lectus in, congue commodo odio.
* Pellentesque luctus vestibulum justo eu porta.
* Vivamus porttitor leo vitae tellus fringilla viverra.
* Ut quis nunc id nisi vehicula posuere.
* Suspendisse sem sem, fringilla ac lacinia et, rutrum et ipsum.
* Curabitur porttitor justo sapien, et scelerisque erat sollicitudin a.
* In id quam lectus. Vestibulum sed nunc tempus leo dapibus scelerisque vel ut ligula.
* Aliquam tempor iaculis arcu non interdum.
* </vn-text>
* </vn-view>
* </vn-scroll-area>
* </template>
*
* <script>
* export default { };
* </script>
* ```
*
* ## What it looks like?
*
* 
*
* ## Props and styling
*
* You can find all the props `vn-scroll-area` accepts listed below.
* Apart from this, you can take a look at the [styling](/docs/guides/3-styling)
* and [event handling](/docs/guides/5-handle-events) docs
*/
export interface ScrollAreaProps extends ViewProps {
widgetResizable?: boolean;
}
export declare const scrollAreaPropsSetters: PropSetters<VNScrollArea, ScrollAreaProps>;
/** @internal */
export declare class VNScrollArea extends QScrollArea implements VNWidget<ScrollAreaProps> {
insertChild(child: NodeWidget<any>): void;
patchProp(key: keyof ScrollAreaProps, prevValue: Prop<ScrollAreaProps, typeof key>, nextValue: Prop<ScrollAreaProps, typeof key>): void;
removeChild(child: NodeWidget<any>): void;
insertBefore(child: NodeWidget<any>): void;
getNextSibling(): NodeWidget<any> | null;
}