aswi20220x00-gitlab/webapp/contexts/TagContext.tsx @ ed01528f

import React, { createContext, useEffect, useState } from 'react';
import { TagInfo } from '../api';

/**
 * Interface of a tag context provider.
 */
interface ITagContextProvider {
    /**
     * Tags managed by the context.
     */
    tags: TagInfo[] | null;

    /**
     * Sets new tags.
     * @param newTags An array of new tags.
     */
    setTags: (newTags: TagInfo[] | null) => void;
}

/**
 * The tag context that manages available tags.
 */
export const TagContext = createContext<ITagContextProvider>({
    /**
     * Default tags.
     */
    tags: null,

    /**
     * Default implementation of setTags method.
     * @param v Array of new tags.
     */
    setTags: (v) => {
        return;
    },
});

/**
 * Provider of the tag context.
 * @param props Children that should have access to the tag context.
 * @returns Prepared html of the provider.
 */
const TagProvider = (props: { children: React.ReactNode }) => {
    /**
     * Tags managed by the context.
     */
    const [tags, setTags] = useState<TagInfo[] | null>(null);

    /**
     * Initializes the context.
     */
    useEffect(() => {
        //TODO: Implement initialization with values from the server
    }, []);

    return (
        <TagContext.Provider
            value={{
                tags,
                setTags,
            }}
        >
            {props.children}
        </TagContext.Provider>
    );
};

export default TagProvider;