Function useAssetsByProject

  • Custom React hook to fetch and manage assets specific to a project.

    This hook is a wrapper around useAssets, pre-configured to fetch assets for a specific project by providing the projectId parameter.

    Parameters

    • projectId: string

      The ID of the project to fetch assets for.

    • Optional params: any = {}

      Additional parameters to filter and paginate assets.

    Returns UseAssetsReturn

    The returning object contains:

    • assets: An array of extended asset objects.
    • fetched: Boolean indicating whether the assets have been successfully fetched.
    • hasMore: Boolean indicating whether there are more assets available to fetch.
    • currentPage: The current page number of the fetched assets.
    • fetchMore: AssetsFetchMoreMethod - Function to fetch more assets, typically for pagination.
    • refresh: AssetsFetchMethod - Function to refresh or re-fetch the assets.

    Example

    import { useAssetsByProject } from 'react-playmakers';

    const ProjectAssets = () => {
      const { assets, fetched, hasMore, fetchMore, refresh } = useAssetsByProject
    ("pXXXXXXXX", { tags: ["adobeillustrator"], limit: 10 });

      useEffect(() => {
        if (!fetched) {
          console.log("Fetching project assets...");
        }
      }, [fetched]);

      return (
        <div>
          {assets.map(asset => (
            <div key={asset.id}>
              <p>{asset.name}</p>
              <button onClick={() => asset.delete()}>Delete</button>
            </div>
          ))}
          {hasMore && <button onClick={() => fetchMore()}>Load More</button>}
          <button onClick={refresh}>Refresh</button>
        </div>
      );
    };

    export default ProjectAssets;

Settings

Member Visibility

Theme

Generated using TypeDoc