Iniciar Checklist

Abre um widget de Checklist pelo seu ID. Se outra Checklist já estiver visível, esta a substituirá pela especificada.

Definição de tipo

 type launchChecklist = (
	checklistId: number,
	options?: {
		itemsShown?: boolean
	}
 ) => void

Parâmetros opcionais:

• itemsShown (booleano) – Indica se os itens da checklist devem ser exibidos imediatamente (expandidos) ao ser iniciada. O padrão é falso (por padrão, ao iniciar uma checklist, apenas o ícone de inicialização da checklist ou o widget minimizado será exibido).

Exemplos

Aciona uma checklist com opções padrão

 userGuiding.launchChecklist(1234)

Acionar uma checklist expandida

 userGuiding.launchChecklist(1234, {
 itemsShown:true
 })

Expandir a checklist

Expande a área de conteúdo de um widget de Checklist ativo (iniciado). Se a checklist estiver recolhida/minimizada, esta opção a abrirá para exibir todos os itens da lista.

Definição de tipo

 type expandChecklist = () => void

Exemplo:

Se a checklist ativa estiver recolhida, expande-a para mostrar seus itens.

 userGuiding.expandChecklist();

Recolher a checklist

Recolhe a área de conteúdo de um widget de Checklist ativo. Isso oculta os itens da checklist, deixando visível apenas o iniciador da checklist.

Definição de tipo

 type collapseChecklist = () => void

Exemplo:

A checklist se fecha se estiver aberta.

 userGuiding.collapseChecklist();

Ocultar a Checklist

Fecha/oculta a Checklist atualmente ativa e o iniciador da página.

Definição de tipo

 type hideChecklist = () => void

Exemplo:

Oculta qualquer checklist ativa

 userGuiding.hideChecklist();

Obtenha informações sobre como concluir a checklist

Retorna o status de conclusão de todas as checklists do usuário atual. Este método fornece um array de objetos de informações da checklist, cada um contendo o ID da lista e listas dos IDs dos itens que estão concluídos ou incompletos.

Definição de tipo

 type getChecklistCompletionInfo = () => {
  id: number
  items: string[]
  completedItems: string[]
  incompleteItems: string[]
 }[]

Exemplo:

 userGuiding.getCheklistCompletionInfo()

Saída:

 [
	{
		id: 11719,
		items: [
			"82ef304a-63a1-4ff4-aacb-4f656420b478"
		],
		completedItems: [],
		incompleteItems: [
			"82ef304a-63a1-4ff4-aacb-4f656420b478"
		]
	},
	{
		id: 11715,
		items: [],
		completedItems: [],
		incompleteItems: []
	}
 ]