useLists

useLists(options?: ListsOptions, deps?: any[]): IListInfo[] | null | undefined;

Returns list collection.

Examples

Get site lists,

const listInfo = useLists();

Query site lists,

const emptyLists = useList({
	query: {
		select: ["Title", "Id"],
		filter: "ItemCount eq 0"
	}
});

Parameters

NameTypeDescriptionTracked for changes
options?ListsOptionsuseLists hook optionsPartially
deps?DependencyListHook dependency list.Yes