useListAsStream

useListAsStream(
	list: string,
	parameters: RenderListParameters,
	options?: ListAsStreamOptions,
	deps?: any[]): IRenderListDataAsStreamResult | null | undefined;

Returns data for the specified query view.

Examples

Basic usage

const renderData = useListAsStream("5ee53613-bc0f-4b2a-9904-b21afd8431a7", {
	dataParameters: {
			Paging: "TRUE",
			RenderOptions: RenderListDataOptions.ListData
		},
		dataOverrideParameters: {
			PageFirstRow: "1",
			PageLastRow: "30",
		},
		useQueryParameters: true
	}
);

Parameters

NameTypeDescriptionTracked for changes
liststringList UUID or titleYes
parametersRenderListParametersRender parametersNo
options?ListAsStreamOptionsuseListAsStream hook optionsPartially
deps?DependencyListHook dependency list.Yes