Client側における空ページの扱いと命名

空ページ = isEmpty: true なページのこと

扱い

基本

  • GROWIのクライアントコード上では、ページが存在する = 空ページではない、というのが基本。
    • 「ページが存在する」のページとは
        • useSWRxPage などでAPIを叩いたり、ページにアクセスした時などにバックエンドから取得されたページのオブジェクト

特別枠

現状では以下の箇所にて、取得したページが空ページである可能性があり、区別をする必要がある

  • ページツリーの表示の時
  • notFound ページの表示の時

例えば useSwrxPage はそもそも空ページの取得はできないことを前提にしている。 apiv3 の /page/ に関しても空ページは notFound として扱っている

命名

上記扱いを踏まえると、

  • useSWRxPage という SWR Hook の Page は、空でないページを意味する
  • また、useSWRxPage で叩いているAPIエンドポイントの _api/v3/page/ も、空ページの id が渡された場合には、ページは存在しないものとして扱っている。