@danilandreev/material-docs/hooks/useTags/useTags.d.ts

material-docs - react framework for easy creating documentation site in material design style.

/*
 * Author: Andrieiev Danil |  danssg08@gmail.com | https://github.com/DanilAndreev
 * Copyright (C) 2020.
 */

/// <reference types="react" />

import Tag from "../../interfaces/Tag";

export interface TaggingContext {
    /**
     * setTag - function, designed to add tagable element to page.
     * @function
     * @param {string} key
     * @param {Tag} value
     * @example
     * const {setTag} = useTags();
     * setTag("my-object-key", {label: "my label", ref: ObjectRef});
     */
    setTag(key: string, value: Tag): void;

    /**
     * removeTag - function, designed to remove tagable element from page.
     * @param {string} key
     * @example
     * const {removeTag} = useTags();
     * removeTag("my-object-key");
     */
    removeTag(key: string): void;

    /**
     * tags - all registered tags in page.
     * @type any
     */
    tags: any;
}

/**
 * useTags - React hook, used to provide tagable mechanism.
 * @returns {{setTag: setTag, tags: *}}
 * @example
 * const {setTag} = useTags();
 */

declare const useTags: () => TaggingContext;
export default useTags;